Skip to content

GitLab Pages

Projects can automatically publish a documentation site powered by Material for MkDocs and GitLab Pages.

  • Get started by creating mkdocs.yml and docs/ files.
  • GitLab Pages has a tutorial on how to write these files.
  • With those in place, a site gets re-published every time the default branch changes. We only auto-publish the default branch for now.
  • Material for MkDocs has a great docs site and offers lots of plugins that should work on our GitLab pages. You may need to install their prerequisites in a before_script step in the pages job.