Documentation

Build Pages Config Reference

Build Pages config is the site-local configuration format used by @zeropress/build-pages.

Build Pages Config Reference

Build Pages config is the site-local configuration format used by @zeropress/build-pages.

It is not preview-data and it is not a theme manifest. Build Pages reads this config, discovers Markdown, generates preview-data, stages public files, and delegates rendering to @zeropress/build.

This is the compact field reference. For workflow examples, file layout, and authoring guidance, use the practical Build Pages Config guide.

Current Schema

Default Location

docs/
  .zeropress/
    config.json

The source root is controlled by the GitHub Action source input or CLI --source.

Common Fields

  • version
  • site
  • front_page
  • menus
  • custom_html

site intentionally exposes a narrow user-facing surface:

  • title
  • description
  • url
  • expose_generator
  • search
  • indexing
  • footer

Renderer-only preview-data fields such as date/time formatting and permalink defaults are generated internally.

Workflow Guide

For practical usage, see Build Pages and Build Pages Config.