Getting Started

GitHubリポジトリをつくる

1. GitHubでリポジトリをつくる。Publicにしないといけない。
2. ローカルにクローン。

Material for MkDocsをInstall

pip install mkdocs-material

• Material for MkDocs

プロジェクト作成

mkdocs new .

mkdocs.ymlに必要事項を記載

theme:
    name:material

ローカルで確認

mkdocs serve

GitHubにデプロイ

mkdocs gh-deploy

GitHub Pageで確認。

https://kyphd.github.io/renow-docs/

code highlight

• https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#adding-annotations