產生網頁檔
觀看build指令說明
$ mkdocs build --help
顯示
Usage: mkdocs build [OPTIONS]
Build the MkDocs documentation
Options:
-c, --clean Remove old files from the site_dir before
building
-f, --config-file FILENAME Provide a specific MkDocs config
-s, --strict Enable strict mode. This will cause MkDocs
to abort the build on any warnings.
-t, --theme [yeti|slate|journal|cyborg|cerulean|amelia|mkdocs|cosmo|spacelab|material|readable|united|flatly|bootstrap|simplex|readthedocs]
The theme to use when building your
documentation.
-d, --site-dir PATH The directory to output the result of the
documentation build.
-q, --quiet Silence warnings
-v, --verbose Enable verbose output
-h, --help Show this message and exit.
產生網頁檔
執行
$ mkdocs build
顯示
INFO - Building documentation to directory: /home/user/Project/note/site
觀看site資料夾結構
執行
$ tree site
顯示
site/
├── 404.html
├── base.html
├── content.html
├── css
│ ├── base.css
│ ├── bootstrap-custom.min.css
│ ├── font-awesome-4.5.0.css
│ └── highlight.css
├── fonts
│ ├── fontawesome-webfont.eot
│ ├── fontawesome-webfont.svg
│ ├── fontawesome-webfont.ttf
│ └── fontawesome-webfont.woff
├── img
│ ├── favicon.ico
│ └── grid.png
├── index.html
├── __init__.py
├── js
│ ├── base.js
│ ├── bootstrap-3.0.3.min.js
│ ├── highlight.pack.js
│ └── jquery-1.10.2.min.js
├── mkdocs
│ ├── js
│ │ ├── lunr-0.5.7.min.js
│ │ ├── mustache.min.js
│ │ ├── require.js
│ │ ├── search.js
│ │ ├── search-results-template.mustache
│ │ └── text.js
│ └── search_index.json
├── nav.html
├── nav-sub.html
├── __pycache__
│ └── __init__.cpython-34.pyc
├── sitemap.xml
└── toc.html
7 directories, 31 files
更多參考
- MkDocs / Building the site