設定佈景主題

從「這裡」或是「這裡」，可以找到一些theme可以替換使用。

設定方式

編輯「mkdocs.yml」

theme: readthedocs

上面就是設定theme為「readthedocs」

內建的theme

在我的系統，內建的有兩個

$ ls ~/.pyenv/versions/3.4.4/lib/python3.4/site-packages/mkdocs/themes -1

顯示

__init__.py
mkdocs
__pycache__
readthedocs

也就是內建的theme有「mkdocs」和「readthedocs」可以選。

除了可以看自己機器上的檔案，也可以到「GitHub」上去觀看。

額外的theme

• mkdocs-bootstrap (warehouse) (pypi) (github)
• mkdocs-bootswatch (warehouse) (pypi) (github)
• mkdocs-material (warehouse) (pypi) (github)

如何知道系統有目前有哪些theme可以選擇

執行

$ mkdocs build --help | grep theme

或是

$ mkdocs serve --help | grep theme

顯示

-t, --theme [readthedocs|cyborg|united|amelia|yeti|journal|readable|simplex|mkdocs|slate|material|bootstrap|flatly|cosmo|cerulean|spacelab]
                                The theme to use when building your

安裝

安裝「mkdocs-material」

$ pip install mkdocs-material

更多參考

• MkDocs / Theming our documentation
• MkDocs / Styling your docs
• MkDocs / Custom themes
• Github / mkdocs / MkDocs Themes