Документация

Notepub — это publishing-движок в одном бинарнике, который генерирует html из markdown по правилам и конфигу, описанным в rules.yaml и config.yaml, соответственно.

Если вы только начинаете, идите по порядку:

1. Обзор
2. Быстрый старт
3. Template-репозитории
4. Структура контента в recipe-репозиториях
5. Сборка и деплой
6. Локальный запуск
7. Бриф для AI/MCP-агента

Дальше углубляйтесь по разделам:

• Концепции и архитектура
• Авторинг контента
• Эксплуатация
• Справочник

Что дает Notepub

• Markdown-контент из локальных папок или S3.
• Декларативную маршрутизацию, шаблоны, связи и коллекции.
• Два режима работы:
  • serve для динамического рендеринга.
  • build для статического HTML в dist/.
• SEO-артефакты по умолчанию: sitemap, robots, canonical, OpenGraph, JSON-LD.

Базовый no-code workflow

Если вы используете recipe-репозиторий с GitHub Actions, чаще всего вы редактируете только:

• content/*.md
• config.yaml
• rules.yaml (по необходимости)

Workflow запускает validate + build и деплоит сайт в GitHub Pages.