SRV_MKDOCS
Co je to reverse MKDOCS?
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
Převzato z: https://www.mkdocs.org
Odkazy ke studiu:
Návod na instalaci
1) Založíme nový LXC container
dle tohoto návodu: https://intranet.rs-kovarik.cz/srvtemplate Místo SRV_TEMPLATE zadat jméno SRV_MKDOCS
2) Připojíme se k serveru přes terminál
ssh připojení k Turiisu a pak přes lxc-attach
Příkazy:
lxc-attach SRV_MKDOCS
3) Instalace apache2 + pip + git
Příkazy:
apt update
apt install apache2 python3-pip git libgdk-pixbuf2.0-0 pango1.0-tests libcairo2-dev
apt install libjpeg-dev zlib1g-dev
4) Instalace mkdocs
Návod zde: https://www.mkdocs.org
Příkazy:
pip3 install --upgrade pip
python3 -m pip install mkdocs --user
apt-get install -y mkdocs
5) Instalace material for mkdocs
Návod zde: https://squidfunk.github.io/mkdocs-material/
Příkazy:
python3 -m pip install mkdocs-material --user
6) Instalace doplňků pro mkdocs
Příkazy:
python3 -m pip install pygments --user
python3 -m pip install pymdown-extensions --user
python3 -m pip install mkdocs-git-revision-date-plugin==0.2 --user
python3 -m pip install mkdocs-macros-plugin --user
python3 -m pip install Pillow --user
python3 -m pip install mkdocs-pdf-export-plugin --user
python3 -m pip install cairocffi==0.9.0 --user
python3 -m pip install mkpdfs-mkdocs --user
7) Vytvoření dokumentace
Příkazy:
mkdocs new kovarik-doc
cd kovarik-doc
8) Napojení material for mkdocs na mkdocs
Do složky kovarik-doc nahrajeme n ásledující souubory (rozbalime zip): KOVARIK-DOC.zip
V souboru mkdocs.yml si nastavíme vlastní parametry (IP, název, git repozitář atd.)
9) Inicializace git
Příkazy:
cd kovarik-doc
git init
git add ./
git commit
napíšeme commit message
ctrl + x y enter
10) Build dokumentace
Příkazy:
cd /root/kovarik-doc
mkdocs build --clean
11) Publikace dokumnetace
Příkazy:
rm -r /root/kovarik-docs/sit
rm -r /var/www/html/
rsync -a /root/kovarik-docs/site/ /var/www/html/
Následně je dokumentace dostupná na http://IP_SRV_MKDOCS/
12) Další možná užitečná rozšíření (volitelné nechávám k samostudiu)
Zdroj:
https://github.com/byrnereese/mkdocs-git-committers-plugin
https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
13) Automatic build
Využijeme docker kontainer kovarikto/mkdoc-builder:1.0 a gitlab CI