MkDocs コンテンツを GItLab Pages で公開

ディレクトリ構成

プロジェクトのルートディレクトリに mkdocs.yml が配置されている前提とします:

.
├── docs
│   └── index.md
├── .gitlab-ci.yml
└── mkdocs.yml

設定ファイル

.gitlab-ci.yml

デフォルトブランチに push した際に runner が実行され、pages が更新されます。

stages:
  - deploy
image: python:slim
pages:
  stage: deploy
  script:
    - pip install mkdocs
    - pip install mkdocs-material
    - mkdocs build
    - mkdir public
    - mv site/* public/
  artifacts:
    paths:
      - public
  rules:
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH