Documentation

Notepub is a single-binary publishing engine that generates HTML from markdown using rules in rules.yaml and settings in config.yaml.

If you are just starting, follow this order:

1. Overview
2. Getting Started
3. Template Repositories
4. Content Structure in Recipe Repositories
5. Build and Deploy
6. Local Run
7. AI/MCP Agent Brief

Then go deeper by area:

• Concepts and Architecture
• Content Authoring
• Operations
• Reference

What Notepub gives you

• Markdown content from local folders or S3.
• Declarative routing, templates, links, and collections.
• Two operation modes:
  • serve for dynamic rendering.
  • build for static HTML in dist/.
• SEO artifacts by default: sitemap, robots, canonical, OpenGraph, JSON-LD.

Basic no-code workflow

If you use a recipe repository with GitHub Actions, most of the time you only edit:

• content/*.md
• config.yaml
• rules.yaml (as needed)

Workflow runs validate + build and deploys site to GitHub Pages.