Справочник

Для разметки контента используется markdown, собирается сайт движком MKDocs.

Участие

Чтобы исправить ошибку или добавить что-то новое в этот репозиторий, вам нужно открыть пулл-реквест на Гитхабе. Кроме того, на каждой странице сайта справа от заголовка есть иконка редактирования (карандаш).

Сборка справочника

Для сборки справочника нужно установить MKDocs, расширения PyMdown и тему Material for MkDocs:

pip3 install -r ./requirements.txt

Сборка проекта:

mkdocs build

Режим разработчика:

mkdocs serve --dirtyreload

Публикация

Все одобренные пулл-реквесты будут автоматически опубликованы на сайте справочника