Reference
Action Inputs
Action inputs configure the zeropress-app/zeropress-build-pages@v0 GitHub Action.
Use them to select the Markdown source directory, public asset directory, output directory, theme, and optional build behavior in workflow YAML.
- name: Build ZeroPress Pages
uses: zeropress-app/zeropress-build-pages@v0
with:
source: ./docs
public-dir: ./public
destination: ./_site
Inputs
source
Markdown source directory.
Default:
./docs
This directory contains Markdown pages and optional .zeropress/config.json.
public-dir
Public passthrough directory.
Default: same as source.
If set explicitly, the directory must exist.
with:
source: ./docs
public-dir: ./public
destination: ./_site
destination
Generated static output directory.
Default:
./_site
For GitHub Pages, this directory is passed to actions/upload-pages-artifact.
theme
Bundled theme name.
Default:
docs
Available bundled theme values:
| Value | Meaning |
|---|---|
docs |
Default bundled documentation theme. Alias for docs1. |
docs1 |
Top-navigation theme for small docs sites, package manuals, and compact reference pages. |
docs2 |
Sidebar theme for larger docs sites with command palette search, page TOC, and collection-based previous/next navigation. |
theme-path
Custom local ZeroPress theme directory.
with:
theme-path: ./theme-docs
theme-path takes precedence over theme. Custom themes must follow the ZeroPress theme contract; see Theme Authoring.
config
Config file path.
Default:
<source>/.zeropress/config.json
site-url
Canonical site URL override.
Use this when the deployment URL should override the config file.
skip-untitled-markdown
Skips Markdown files without a title instead of failing.
Default:
false
skip-link-check
Skips internal link checking after build.
Default:
false
Broken internal links are reported as warnings and do not fail the build.
copy-markdown-source
Copies original Markdown files to the generated output.
Default:
true
Set to false when original Markdown source should not be published.
with:
copy-markdown-source: false
When false, public passthrough .md files are also skipped.