MkDocs のインストール

詳細ガイド。

要件

MkDocs には、最近のバージョンの Python と Python パッケージマネージャー、pip がシステムにインストールされている必要があります。

コマンドラインから、これらのパッケージがすでにインストールされているかどうかを確認できます。

$ python --version
Python 3.8.2
$ pip --version
pip 20.0.2 from /usr/local/lib/python3.8/site-packages/pip (python 3.8)

これらのパッケージがすでにインストールされている場合は、MkDocs のインストール までスキップできます。

Python のインストール

Python を選択したパッケージマネージャーを使用してインストールするか、python.org からご使用のシステムに適したインストーラーをダウンロードして実行します。

pip のインストール

最新の Python バージョンを使用している場合、Python パッケージマネージャー、pip は、ほとんどの場合既定でインストールされています。ただし、pip を最新バージョンにアップグレードする必要がある場合があります。

pip install --upgrade pip

pip を初めてインストールする必要がある場合は、get-pip.py をダウンロードしてください。このコマンドを実行してインストールします。

python get-pip.py

MkDocs のインストール

pip を使用して mkdocs パッケージをインストールします。

pip install mkdocs

mfdocs コマンドがシステムにインストールされているはずです。mkdocs --version を実行して、すべてが正常に機能していることを確認します。

$ mkdocs --version
mkdocs, version 1.2.0 from /usr/local/lib/python3.8/site-packages/mkdocs (Python 3.8)

pip install click-man
click-man --target path/to/man/pages mkdocs

python -m pip install mkdocs
python -m mkdocs