Articles Hierarchy

Articles Home » RPI » MkDocs ? simple site creator ?

Jul 21 2022

MkDocs ? simple site creator ?

Posted by kll · In RPI · 287 Reads ·

checking on green-ee.com i see its made with MkDocs

i fire up my RPI4 '32bit bullseye'
and try to play.

---

under ~/projects/myMkDocs/
pi@RPI4:~/projects/myMkDocs $ pip --version
pip 20.3.4 from /usr/lib/python3/dist-packages/pip (python 3.9)
pi@RPI4:~/projects/myMkDocs $ python --version
Python 3.9.2

pip install mkdocs
Successfully installed ghp-import-2.1.0 mergedeep-1.3.4 mkdocs-1.3.1 packaging-21.3 pyparsing-3.0.9 python-dateutil-2.8.2 pyyaml-env-tag-0.1 watchdog-2.1.9

reboot
pi@RPI4:~/projects/myMkDocs $ mkdocs --version
mkdocs, version 1.3.1 from /home/pi/.local/lib/python3.9/site-packages/mkdocs (Python 3.9)

ok from above
cd ~/projects
mkdocs new myMkDocs

you get a mkdocs.yml
and a /docs/index.md
file

---

pi@RPI4:~/projects/myMkDocs $ mkdocs serve
INFO - Building documentation...
INFO - Cleaning site directory
INFO - Documentation built in 0.25 seconds
INFO - [15:29:26] Watching paths for changes: 'docs', 'mkdocs.yml'
INFO - [15:29:26] Serving on http://127.0.0.1:8000/

[ctrl][c]
mkdocs build

---