Перейти к основному содержимому

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

Документация проекта доступна онлайн: https://fedorabakumets.github.io/wikinest/

WikiNest читает markdown-файлы из папки docs/ этого репозитория и отображает их как wiki-сайт.

Как добавить новую страницу​

  1. Создай .md файл в нужной подпапке docs/
  2. Файл обязательно должен начинаться с # Заголовок — это будет название в сайдбаре
  3. Запуши в main
  4. GitHub Actions автоматически обновит tree.json
  5. Через ~5 минут страница появится на сайте

Как редактировать существующую страницу​

  • Редактируй файл локально и пуш в main
  • Или редактируй прямо в браузере на WikiNest (нужен PAT токен)

Структура папок​

ПапкаНазначениеOrder
development/Инструкции для разработчиков1
features/Описание возможностей2
deployment/Гайды по деплою3
futures/Планы на будущее4
releases/Release notes5
smm/Маркетинг и посты6

Правила оформления​

  • Первая строка — # Заголовок (обязательно, иначе в сайдбаре будет мусор)
  • Язык — русский (для EN-версий добавлять суффикс .en.md)
  • Wiki-ссылки между страницами: [[путь/к/странице]]
  • Обычные ссылки тоже работают: [текст](путь/к/странице)

Кастомизация папок (_meta.json)​

В каждой папке можно создать _meta.json для настройки отображения:

{
  "title": "🛠️ Разработка",
  "order": 1
}
  • title — название папки в сайдбаре (поддерживает эмодзи)
  • order — порядок сортировки (меньше = выше)

Автоматическое обновление tree.json​

При пуше в main с изменениями в docs/** запускается GitHub Actions workflow .github/workflows/build-tree.yml. Он:

  1. Сканирует все .md файлы в docs/
  2. Извлекает заголовки, теги, даты
  3. Генерирует tree.json и search.json
  4. Коммитит результат

Ручной запуск (если нужно): python tools/generate_tree_json.py

Кеширование​

GitHub CDN кеширует tree.json на ~5 минут. Если после пуша изменения не видны:

  • Подожди 5 минут
  • Или очисти localStorage: F12 → Application → Local Storage → Clear

Технические детали​

  • WikiNest форк: https://github.com/fedorabakumets/wikinest
  • Config: config.json в форке (owner/repo указывают на эту репу)
  • Скрипт генерации: tools/generate_tree_json.py
  • Workflow: .github/workflows/build-tree.yml