MkDocs

https://www.mkdocs.org/

Python製の静的サイトジェネレータ。
ページ構成を多段にできないので、あまりスケールできないと思われる。

※mkdocs-materialだと少なくとも2階層にはできる。

Getting Started

参考:

MkDocsによるドキュメント作成 - Qiita

Installation

いくつか選択肢がある

パッケージマネージャー
pip install mkdocs

後述のmkdocs-materialを使うなら、そちらのDockerイメージを使う手も有る。MkDocsも含まれているので。

参考:

2020-06-20#MkDocs事始め

Quickstart

https://www.mkdocs.org/#getting-started

# プロジェクト作成
mkdocs new my-project
cd my-project

# Webサーバ起動
mkdocs serve

# サイトのビルド
mkdocs build

Usage

ページの追加

https://www.mkdocs.org/#adding-pages

docs/ 以下にMarkdownファイルを追加
config file (mkdocs.yml) で設定

設定例:

site_name: MkLorum
nav:
  - Home: index.md
  - About: about.md
theme: readthedocs

GitHub Pagesへのデプロイ

公式マニュアルがあるが、GitHub ActionなどCIを利用した方が楽だろう。

GitHub Action

下の参考記事に上げた@peaceiris先生の記事に詳しいやり方が載っているので、一読すると良い。

2020-07-17、binqry.github.ioでは次のように設定した。

name: github pages

on:
  push:
    branches:
      - source

jobs:
  deploy:
    runs-on: ubuntu-18.04
    steps:
      - uses: actions/checkout@v2

      - name: Setup Python
        uses: actions/setup-python@v2
        with:
          python-version: '3.x'
          architecture: 'x64'

      - name: Cache dependencies
        uses: actions/cache@v2
        with:
          path: ~/.cache/pip
          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
          restore-keys: |
                        ${{ runner.os }}-pip-

      - name: Install dependencies
        run: |
          python3 -m pip install --upgrade pip
          python3 -m pip install -r ./requirements.txt          

      - run: mkdocs build

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./site
          publish_branch: master