Install MkDocs
Environment
- Debian 9.7 x64
- Python 2.7.13
pip
19.1.1- MkDocs 1.0.4
Excerpt https://www.mkdocs.org/#installation
Pre-requisite Install pip
Log 2019 / 05
1. Install MkDocs
root@athos:~# apt-get update && apt-get -y upgrade && apt-get -y dist-upgrade
root@athos:~# pip install --upgrade pip
Requirement already up-to-date: pip in /usr/local/lib/python2.7/dist-packages (18.1)
root@athos:~# pip install mkdocs
(truncated)
Successfully built tornado
Installing collected packages: backports-abc, futures, singledispatch, tornado,
livereload, MarkupSafe, Jinja2, setuptools, Markdown, click, mkdocs
Successfully installed Jinja2-2.10.1 Markdown-3.1 MarkupSafe-1.1.1 backports-abc-0.5
click-7.0 futures-3.2.0 livereload-2.6.1 mkdocs-1.0.4 setuptools-41.0.1
singledispatch-3.4.0.3 tornado-5.1.1
root@athos:~# mkdocs -V
mkdocs, version 1.0.4 from /usr/local/lib/python2.7/dist-packages/mkdocs (Python 2.7)
2. MkDocs new
root@athos:~# mkdocs new athos ; cd athos/
INFO - Creating project directory: athos
INFO - Writing config file: athos/mkdocs.yml
INFO - Writing initial docs: athos/docs/index.md
root@athos:~/athos# ls -lF
total 8
drwxr-xr-x 2 root root 4096 May 12 15:22 docs/
-rw-r--r-- 1 root root 19 May 12 15:22 mkdocs.yml
3. MkDocs serve
root@athos:~/athos# mkdocs serve -a 0.0.0.0:8080
INFO - Building documentation...
INFO - Cleaning site directory
[I 190512 15:23:11 server:296] Serving on http://0.0.0.0:8080
[I 190512 15:23:11 handlers:62] Start watching changes
[I 190512 15:23:11 handlers:64] Start detecting changes
4. MkDocs build
root@athos:~/athos# mkdocs build
INFO - Cleaning site directory
INFO - Building documentation to directory: /root/athos/site
root@athos:~/athos# ls -lF site/
total 44
-rw-r--r-- 1 root root 5487 May 12 15:23 404.html
drwxr-xr-x 2 root root 4096 May 12 15:23 css/
drwxr-xr-x 2 root root 4096 May 12 15:23 fonts/
drwxr-xr-x 2 root root 4096 May 12 15:23 img/
-rw-r--r-- 1 root root 6454 May 12 15:23 index.html
drwxr-xr-x 2 root root 4096 May 12 15:23 js/
drwxr-xr-x 2 root root 4096 May 12 15:23 search/
-rw-r--r-- 1 root root 222 May 12 15:23 sitemap.xml
-rw-r--r-- 1 root root 190 May 12 15:23 sitemap.xml.gz