Mkdocsを構築する

Mkdocsは、マークダウンで記述することができるサイト作成ツールです。

今回はWindows上で構築します。

1. Python 3.7をインストールします。

   下記サイトからダウンロードして、インストールします。
   https://www.python.org/downloads/

2. PythonのPATHを通します。

   D:\>set PATH=%PATH%;D:\Python\Python37;D:\Python\Python37\Scripts
   

3. pipをつかってMkDocsをインストールします。

   D:\>pip install mkdocs
   Successfully installed Jinja2-2.10 Markdown-3.0.1 MarkupSafe-1.1.0 PyYAML-3.13 click-7.0 livereload-2.6.0 mkdocs-1.0.4 six-1.12.0 tornado-5.1.1
   

4. ドキュメントのルートを作成します。

   D:\>mkdocs new mydoc
   INFO    -  Creating project directory: mydoc
   INFO    -  Writing config file: mydoc\mkdocs.yml
   INFO    -  Writing initial docs: mydoc\docs\index.md
   

5. サーバを起動します。

   D:\>cd mydoc
   D:\mydoc>mkdocs serve
   INFO    -  Building documentation...
   INFO    -  Cleaning site directory
   [I 190114 17:01:52 server:298] Serving on http://127.0.0.1:8000
   [I 190114 17:01:52 handlers:59] Start watching changes
   [I 190114 17:01:52 handlers:61] Start detecting changes
   

6. これで、 http://127.0.0.1:8000 にアクセスすると画面が表示されます。