docker/getting-started のドキュメントを編集してみる (MkDocs)

docker/getting-startedはMkDocsで作られている様子。

getting-started の構成

• docs : ドキュメントが入っている
• docs/index.md : tutorial へのリダイレクト設定
• docs/tutorial/index.md : tutorial の内容
• app/src/static/index.html : .mdから.htmlに変換されたもの

cd getting-started

日本語検索 参考 公式

mkdocs.yml

  theme:
    name: material
-   language: en
+   language: ja

...

  extra:
    social:
      - type: github-alt
        link: https://github.com/docker/getting-started
+   search:
+     language: ja

docker-compose up

• http://localhost:8000 でリアルタイムに変更を確認できる。

# ビルド
docker build -t docker/getting-started .

# 起動
docker run -d -p 80:80 docker/getting-started

良いところ

• 空白を入れてもコードブロックとして認識してくれる。
• 幅の指定などができる

参考