使用「pip」安裝「MkDocs」
前置作業
若沒使用「pyenv」,這個步驟可以省略。
指定目前Shell要使用的python版本。
$ pyenv shell 3.4.4
指定目前資料夾要使用的python版本
$ pyenv local 3.4.4
pyenv local
這個指令,就會目前產生「.python-version」
$ cat .python-version
顯示
3.4.4
以後進入這個資料夾或子資料夾,就會使用「3.4.4」,但若有使用pyenv shell
指定,則會先採用pyenv shell
的設定。
安裝
安裝「MkDocs」
$ pip install mkdocs
觀看說明
$ mkdocs -h
或
$ mkdocs --help
顯示
Usage: mkdocs [OPTIONS] COMMAND [ARGS]...
MkDocs - Project documentation with Markdown.
Options:
-V, --version Show the version and exit.
-q, --quiet Silence warnings
-v, --verbose Enable verbose output
-h, --help Show this message and exit.
Commands:
build Build the MkDocs documentation
gh-deploy Deploy your documentation to GitHub Pages
json Build the MkDocs documentation to JSON files...
new Create a new MkDocs project
serve Run the builtin development server
觀看版本
執行
$ mkdocs -V
或
$ mkdocs --version
顯示
mkdocs, version 0.15.3
更多參考
- MkDocs / Installation
- Python Packaging User Guide / Installing Packages / Use pip for Installing