Material for MkDocs の Boilerplate (Starter Kit) を公開しました。

Netlify, GitHub Pages, GitLab Pages, AWS Amplify Console などにすぐデプロイできるよう、設定ファイル等が含まれています。

Issue, Pull Request, GitHub Star ⭐️お待ちしてます。

👉 peaceiris/mkdocs-material-boilerplate - GitHub

MkDocs Material Boilerplate (Starter Kit) - Deploy documentation to platforms (Netlify, GitHub Pages, GitLab Pages, and AWS Amplify Console) with CircleCI, Docker, pipenv, GitHub Actions.

ボイラープレートの特徴

静的サイトジェネレーター MkDocs のマテリアルデザインテーマ Material for MkDocs をすぐに利用・デプロイするためのテンプレートです。

Markdown で記事を書いて、記事一覧・目次・様々な修飾が用意されているドキュメントサイトを生成できます。

Docker で簡単に MkDocs Material を実行
pipenv, pip (conda) での導入にも対応
自動ビルド・デプロイを設定済み
- Netlify へ1クリックでデプロイ可能
- GitHub Pages + CircleCI or GitHub Actions
- GitLab Pages + GitLab CI/CD
- AWS Amplify Console

以下はこのボイラープレートで設定済みの Material for MkDocs の機能です。

MathJax 導入済み
クライエントサイドでの日本語による全文検索

公開方法の組み合わせ

以下のようなサービスの組み合わせに対応しています。

GitHub Pages + GitHub +
- mkdocs gh-deploy command
- CircleCI
- GitHub Actions
GitLab Pages + GitLab + GitLab CI/CD
Netlify +
- GitHub
- GitLab
- BitBucket
AWS Amplify Console +
- GitHub
- GitLab
- BitBucket
- AWS CodeCommit

一番楽なのは1クリックで連携・デプロイできる Netlify だと思います。GitLab 使いの人には GitLab Pages が楽でしょう。

ID, Password による認証をかけたい場合には AWS Amplify Console がオススメです。

デモサイト

MkDocs Material Boilerplate