

MkDocs / Docker¶

MkDocsディレクトリを作成¶

1、ディレクトリ構成¶

mkdocs/                                           <= ディレクトリ名は何でも大丈夫
  |-mkdocs.yml                                    <= mkdocsの設定ファイル
  |-docs/                                         <= 基本docsフォルダ
     |-index.md                                   <= トップページになる
     |-memo1.md
     |-directory1/                                <= サブフォルダ
     |  |-memo2.md
     |  |-memo3.md
     |-directory2/                                <= サブフォルダ
     |  |-memo4.md

2、mkdocs.ymlを作成¶

./mkdocks/mkdocs.yml

site_name: My MEMO

# Repository
repo_name:                                           # GitHUBのリポジトリ名
repo_url:                                            # GitHUBのリポジトリのURL

# Configuration
theme:
  name: 'material'
  language: 'ja'
  feature:
    tabs: true
  palette:
    primary: 'brown'
    accent: 'indigo'
  font:
    text: 'Roboto'
    code: 'Roboto Mono'

# 日本語検索設定
extra:
  search:
    language: 'jp'

# Extensions
markdown_extensions:
  - admonition
  - footnotes
  - pymdownx.keys
  - def_list
  - codehilite:
      linenums: true
  - toc:
      permalink: true
  - pymdownx.tasklist:
      custom_checkbox: true

Docker¶

1、Dockerイメージを取得¶

1	$ docker pull squidfunk/mkdocs-material

2、MkDocsのコンテナを起動¶

1	$ docker run --rm -it -p 8000:8000 -v `pwd`:/docs squidfunk/mkdocs-material

3、localhostで表示確認¶

http://localhost:8000で表示確認ができたらOK

Note

マークダウンでの作業がリアルタイムに反映される。

GitHub¶

1、GitHubでリポジトリを作成¶

2、mkdocsディレクトリをGitの管理対象にする。¶

$ git init
$ git add .
$ git commit -m "コメント"
$ git remote add origin URL
$ git push -u origin master

3、GitHubのリポジトリの設定を変更¶

リポジトリのSettingsを選択。
下の方のGitHub Pagesのsourceの箇所でgh-pages branchでsave。

4、WEBで表示確認¶

https://ユーザー名.github.io/リポジトリ名/で表示確認ができたらOK

デプロイ¶

1、GitHub Pagesにアップロード¶

1	$ docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material gh-deploy

Note

上記のコマンドでアップロードができる。
siteというディレクトリが自動生成されそのHTMLが表示される。
gh-pagesというブランチが切られ、siteディレクトリがプッシュされる。