Template Repositories
How recipe repositories are structured and when to customize them.
Template repositories are the default way to start Notepub for most users.
Official template repositories
- Blog template: https://github.com/cookiespooky/notepub-recipe-blog
- Documentation template: https://github.com/cookiespooky/notepub-recipe-docs
- Content repository template for
content_repomode: https://github.com/cookiespooky/np-content-template
What a template repo provides
- Working
config.yamlandrules.yaml. - Starter theme in
theme/. - Initial content in
content/. - CI workflow for validate + build + deploy.
Minimal customization sequence
- Update
site.base_url. - Replace starter content files.
- Update brand values (
site.title,site.description, theme assets). - Change rules when the default model no longer covers your use case.
When to fork workflow
If you need:
- multiple environments/stages
- stricter CI validations
- custom binary version policy
- deploy target outside GitHub
Upgrade strategy
- Keep content and rules as your primary source of truth.
- Upgrade
notepubversion in CI gradually. - Always run
validatebefore rollout.