Skip to content

mkdocs#

Overview#

Build documentation sites with MkDocs.

Usage#

Project Setup#

At a minimum, this pipeline requires that:

  • A mkdocs.yml file is created
  • A docs/ directory exists and contains some Markdown files.

Using the pipeline#

Include the pipeline in the .gitlab-ci.yml file:

include:
  - project: brettops/pipelines/mkdocs
    file: include.yml