Быстрый старт
Краткий путь от нуля до опубликованного сайта с дефолтным local-режимом.
Это самый короткий дефолтный сценарий. Начните с него.
Рекомендуемый дефолт: local-контент в этом же репозитории
- Создайте репозиторий для вашего сайта через Use this template из шаблона Notepub. Доступные шаблоны
- В настройках репозитория включите GitHub Pages с источником GitHub Actions. Здесь же можно указать собственный домен.
- Push изменения в
main. Сборка занимает менее минуты. Процесс можно наблюдать в разделе Actions.
После сборки сайт будет доступен по адресу: https://USER.github.io/REPOSITORY, где USER - ваш GitHub username, а REPOSITORY - название репозитория. Актуальную ссылку можно посмотреть в разделе Settings - Pages репозитория.
Чтобы отредактировать контент вашего сайта, положите ваши markdown-файлы в content/ и удалите лишние.
Важно учитывать frontmatter-разметку в ваших markdown-файлах, чтобы Notepub правильно понимал как собирать ваш сайт. Читайте ниже.
Что делает CI:
- скачивает зафиксированный бинарник
notepub - выполняет index/build
- деплоит
dist/в Pages
Что обычно делают дальше
После первого деплоя обычно нужно:
- Изменить данные сайта (title, description, base_url и другие параметры): Справочник config.yaml
- Изменить шаблоны и внешний вид: Темы и шаблоны
- Запускать проект локально перед push: Локальный запуск
- Если хотите делегировать setup агенту: Бриф для AI/MCP-агента
Если вы работаете через template-repo, смотрите также Template-репозитории.
Минимальный frontmatter
Перед наполнением контента прочитайте Структура контента в recipe-репозиториях — это поможет сразу разложить заметки по правильной модели шаблона (home/hub/article/page/search). Поняв, как устроена структура, вы сможете моделировать собственные markdown-миры и собирать статические сайты любой структуры/сложности/вложенности.
Для типового recipe:
---
type: article
slug: my-first-note #canonical url страницы
title: Заголовок страницы #он же SEO-заголовок
description: Описание заметки #оно же SEO метаописание
draft: false
---
Продвинутые режимы источника контента
- Контент из отдельного репозитория: Режим Content Repository
- Контент из S3-совместимого хранилища: Режим S3
- Поток через Obsidian и настройки variables/secrets: Workflow с Obsidian
Дальше: Справочник config.yaml и Справочник rules.yaml.