Skip to content

MkDocs serve

ref. https://www.mkdocs.org/

mac

on terminal

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
$ brew install Mkdocs
🍺  /usr/local/Cellar/mkdocs/1.1.2_1: 1,672 files, 26.3MB

$ cd fa2021_kannai_site
$ ls
README.md       mkdocs.yml
docs            requirements.txt

$ mkdocs serve
ERROR   -  Config value: 'theme'. Error: Unrecognised theme name: 'material'. The available installed themes are: mkdocs, readthedocs
ERROR   -  Config value: 'plugins'. Error: The "git-revision-date-localized" plugin is not installed

$ curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
$ python3 get-pip.py
Successfully installed pip-21.0

$ pip install mkdocs-material
$ pip install mkdocs-git-revision-date-localized-plugin

$ mkdocs serve
Browser Connected: http://127.0.0.1:8000/
INFO    -  Browser Connected: http://127.0.0.1:8000/

//control + c
Shutting down...

Windows

on gitbash

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
$ python --version
Python 3.9.1

$ pip --version
pip 21.0

$ pip install --upgrade pip
$ pip install mkdocs

$ cd fa2021_kannai_site
$ ls
README.md       mkdocs.yml
docs            requirements.txt

$ mkdocs serve
ERROR   -  Config value: 'theme'. Error: Unrecognised theme name: 'material'. The available installed themes are: mkdocs, readthedocs
ERROR   -  Config value: 'plugins'. Error: The "git-revision-date-localized" plugin is not installed

$ pip install mkdocs-material
$ pip install mkdocs-git-revision-date-localized-plugin

$ mkdocs serve
Browser Connected: http://127.0.0.1:8000/
INFO    -  Browser Connected: http://127.0.0.1:8000/

//control + c
Shutting down...


Last update: January 30, 2021