ZeroPress Public Docs

Documentation

Package Quick Starts

This page shows the shortest useful command for each public ZeroPress package.

Package Quick Starts

This page shows the shortest useful command for each public ZeroPress package.

For complete options and release notes, use each package README.

@zeropress/build-pages

Build a Markdown source tree into static output:

npx @zeropress/build-pages --source ./docs --destination ./_site

GitHub Action:

- name: Build ZeroPress Pages
  uses: zeropress-app/zeropress-build-pages@v0
  with:
    source: ./docs
    destination: ./_site

@zeropress/create-theme

Create a starter theme and fixture preview-data:

npx @zeropress/create-theme --name my-theme --template docs

Templates:

  • minimal
  • blog
  • docs
  • portfolio
  • magazine

@zeropress/theme

Preview a theme:

npx @zeropress/theme dev ./my-theme/theme --data ./my-theme/preview-data.json

Validate a theme:

npx @zeropress/theme validate ./my-theme/theme

Package a theme:

npx @zeropress/theme pack ./my-theme/theme

@zeropress/build

Build directly from a theme and preview-data:

npx @zeropress/build ./theme --data ./preview-data.json --out ./dist

Validators

Most users reach validators through @zeropress/build, @zeropress/theme, or @zeropress/build-pages.

Direct packages:

  • @zeropress/preview-data-validator
  • @zeropress/theme-validator

Use the current schemas when reviewing generated files: