Для сборки сайта из markdown файлов используется генератор статических сайтов MkDocs.
С синтаксисом markdown можно ознакомиться здесь.
- Создайте новую ветку
- Когда работа будет готова — проверьте локально что сайт собирается и запушьте ветку в репозиторий.
- Создайте Pull Request в master.
Для локальной сборки сайта необходимо установить:
- python 3+
- mkdocs
Для установки mkdocs используйте команду pip install mkdocs
Запустить проект:
mkdocs serve