MkDocs Material¶
MkDocs — это генератор статических сайтов на базе Python. Проект существует с 2014 г.
MkDocs Material — начинаясь как тема оформления для MkDocs, постепенно развился в отдельный проект, родственный базовому MkDocs.
- Поддержка GitHub / GitLab Pages
- Кастомизация CSS, темы
- Отключаемая заглавная страница
- Плагины
Документация MkDocs: https://www.mkdocs.org
Документация MkDocs Material: https://squidfunk.github.io/mkdocs-material/
Примеры документации¶
- Arduino — Arduino CLI
- Atlassian — DC Helm Charts
- Bloomberg - Selekt
- CentOS — CentOS Infra Docs
- Intel - Open Active Management Technology Cloud Toolkit
Ссылки текущего проекта¶
Данный проект по исследованию MkDocs размещен на GitHub и опубликован посредством GitHub Pages.
Ссылки проекта:
| Repository URL | GitHub Pages URL | |
|---|---|---|
| Origin | https://github.com/andwr/mkdocs-material-fork | https://andwr.github.io/mkdocs-material-fork |
| Upstream | https://github.com/koshelekapi/mkdocs-material | https://koshelekapi.github.io/mkdocs-material |
Базовая структура проекта¶
mkdocs.yml # Файл конфигурации
docs/
index.md # Домашняя страница
... # Статьи MD