MkDocs
Это система для создания документации. Например, данный сайт создан с помощью mkdocs-material. На просторах Интернета можно встретить много сайтов, созданных на основе данного инструмента. Удобен для создания и поддержки документации в совокупности с git и ci-cd.
Предустановки
Установка python3 и pip3.
sudo apt install python3 python3-pip
Установка mkdocs-material
Создание каталога и виртуального окружения ⚠️ в linux. В другой ОС команды могут отличаться.
mkdir project
cd project
python3 -m venv venv
source venv/bin/activate
pip3 install mkdocs-material
Создание проекта
Создать проект test.
mkdocs new test
Открыть порт 8000 в firewall.
Собрать и запустить проект.
mkdocs build
mkdocs serve [-a `ip`:`port`]
©️ Оформление, изложение, медиаконтент. И. Попов, 2020-2025