Работа с документацией (MkDocs)

В данном проекте документация является обязательной частью и автоматически публикуется в Github Pages. Для внесения правок в документацию используется выделенная ветка edit_docs.

1. Подготовка к работе

Перед началом работы убедитесь, что вы переключились на нужную ветку:

git checkout edit_docs

Установка Material for MkDocs

Для локальной сборки и предварительного просмотра документации вам необходимо установить движок MkDocs и тему Material.

1. Установка через Python

Убедитесь, что у вас установлен Python, затем выполните команду в терминале VSCode:

pip install -r requirements.txt

3. Добавление новых страниц

Документация строится на движке MkDocs, который преобразует Markdown-файлы в веб-сайт.

Создайте файл: Перейдите в папку docs/ и создайте там новый файл с расширением .md (например, docs/my-page.md).

Зарегистрируйте страницу: Откройте файл mkdocs.yaml в корне проекта и добавьте ваш новый файл в структуру навигации (nav):

nav:
  - Home: index.md
  - Моя страница: my-page.md

4. Вставка изображений

Все графические материалы должны храниться внутри структуры документации.

Загрузка: Поместите файл изображения в папку docs/media/ (или создайте её, если она отсутствует).

Синтаксис вставки: В нужном месте .md файла используйте стандартную разметку:

![Описание изображения](media/название-файла.png)

5. Предварительный просмотр

Вы можете видеть изменения в реальном времени без отправки кода на сервер. В терминале VSCode введите:

mkdocs serve