@zeropress/build-pages 0.5.6 → 0.6.2

package/README.md

@@ -5,7 +5,7 @@
 
 Build ZeroPress static output for modern hosting platforms.
 
-`@zeropress/build-pages` turns a directory of Markdown files and public assets into a static ZeroPress site. It discovers Markdown pages, prepares the site data, stages public files, and runs [`@zeropress/build`](https://github.com/zeropress-app/zeropress-build).
+`@zeropress/build-pages` turns Markdown files and public assets into a static ZeroPress site. It discovers Markdown pages, prepares the site data, stages public files, and runs [`@zeropress/build`](https://github.com/zeropress-app/zeropress-build).
 
 The generated output is plain static files that can be deployed to GitHub Pages, Cloudflare Pages, Netlify, Vercel, or any static hosting provider.
 
@@ -13,7 +13,9 @@ The generated output is plain static files that can be deployed to GitHub Pages,
 
 ```txt
 source directory
-  Markdown pages + .zeropress/config.json + public files
+  Markdown pages + .zeropress/config.json
+public directory
+  public files (defaults to source)
         |
         v
 @zeropress/build-pages
@@ -32,7 +34,7 @@ static output directory
 flowchart TD
   source["Source directory"] --> markdown["Markdown pages (*.md)"]
   source --> config[".zeropress/config.json"]
-  source --> publicFiles["Public files<br/>images, CSS, JS, PDF, JSON, Markdown"]
+  publicRoot["Public directory<br/>defaults to source"] --> publicFiles["Public files<br/>images, CSS, JS, PDF, JSON, Markdown"]
 
   markdown --> buildPages["@zeropress/build-pages"]
   config --> buildPages
@@ -82,7 +84,8 @@ jobs:
       - name: Build ZeroPress Pages
         uses: zeropress-app/zeropress-build-pages@v0
         with:
-          source: ./documents
+          source: ./docs
+          public-dir: ./public
           destination: ./_site
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v5
@@ -114,6 +117,7 @@ That is equivalent to:
   uses: zeropress-app/zeropress-build-pages@v0
   with:
     source: ./docs
+    public-dir: ./docs
     destination: ./_site
     theme: docs
     skip-untitled-markdown: false
@@ -128,6 +132,7 @@ Custom input example:
   uses: zeropress-app/zeropress-build-pages@v0
   with:
     source: ./documents
+    public-dir: ./public
     destination: ./_site
     theme-path: ./theme-docs
     config: ./documents/.zeropress/config.json
@@ -137,18 +142,33 @@ Custom input example:
 
 In the action inputs:
 
-- `source` is the directory that contains your Markdown pages, public files, and optional `.zeropress/config.json`. The default is `./docs`.
+- `source` is the directory that contains your Markdown pages and optional `.zeropress/config.json`. The default is `./docs`.
+- `public-dir` is the directory copied as public passthrough files. The default is `source`.
 - `destination` is the directory where the generated static site is written. The default is `./_site`.
 - `theme` is the bundled theme name. The default is `docs`.
 - `theme-path` is a custom local ZeroPress theme directory. It takes precedence over `theme`.
 - `config` is the config file path. The default is `<source>/.zeropress/config.json`.
 - `site-url` overrides the canonical site URL from config.
 - `skip-untitled-markdown` skips Markdown files without a page title instead of failing. The default is `false`.
-- `skip-link-check` skips internal link checking after build. The default is `false`.
+- `skip-link-check` skips internal link checking after build. The default is `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 and enables `View this page as Markdown` links in the bundled docs theme. The default is `true`.
 
 For GitHub Pages, the generated `destination` directory can be passed to `actions/upload-pages-artifact`. For Cloudflare Pages, Netlify, Vercel, or another static host, pass the same `destination` directory to that provider's deploy step.
 
+Need a custom theme? Start with [`@zeropress/create-theme`](https://www.npmjs.com/package/@zeropress/create-theme), then point `theme-path` to the generated `theme/` directory:
+
+```bash
+npx @zeropress/create-theme --name my-docs-theme --template docs
+```
+
+```yaml
+with:
+  source: ./docs
+  public-dir: ./public
+  destination: ./_site
+  theme-path: ./my-docs-theme/theme
+```
+
 ### npx
 
 Use `npx` when you want to run Build Pages without adding it to your project dependencies.
@@ -183,19 +203,20 @@ The CLI requires explicit input and output paths. The GitHub Action keeps safe d
 
 | Option | Default | Purpose |
 | --- | --- | --- |
-| `--source <dir>` | required | Dedicated source directory containing Markdown and public files |
+| `--source <dir>` | required | Dedicated source directory containing Markdown and optional config |
+| `--public-dir <dir>` | source | Public passthrough directory |
 | `--destination <dir>` | required | Output directory |
 | `--theme docs` | `docs` | Bundled docs theme |
 | `--theme-path <dir>` | none | Custom ZeroPress theme directory |
 | `--config <path>` | `<source>/.zeropress/config.json` | Build Pages config |
 | `--site-url <url>` | config `site.url` | Canonical URL override |
 | `--skip-untitled-markdown` | `false` | Skip Markdown without a page title |
-| `--skip-link-check` | `false` | Skip link checking |
+| `--skip-link-check` | `false` | Skip warning-only internal link checking |
 | `--no-copy-markdown-source` | `false` | Do not copy original Markdown files to output |
 
 ## Source Tree
 
-The source directory is the folder that Build Pages reads. It is both the Markdown source root and the public passthrough root. GitHub Action usage defaults to `./docs`; CLI usage requires `--source`.
+The source directory is the folder that Build Pages reads for Markdown pages and optional `.zeropress/config.json`. By default, the source directory is also the public passthrough root. Use `public-dir` when you want to keep Markdown source and public assets separate.
 
 Use a dedicated content directory such as `docs/` or `documents/`. Repository root source (`--source ./`) is not supported.
 
@@ -204,18 +225,25 @@ my-site/
   docs/                 # source
     index.md
     guide.md
-    assets/
-      logo.png
     .zeropress/
       config.json
+  public/               # public-dir, optional
+    assets/
+      logo.png
+    favicon.svg
+    robots.txt
   _site/                # destination, generated
 ```
 
-Build Pages stages the source tree before calling [`@zeropress/build`](https://github.com/zeropress-app/zeropress-build). Generated ZeroPress output wins over staged public files.
+Build Pages stages the public directory before calling [`@zeropress/build`](https://github.com/zeropress-app/zeropress-build). Generated ZeroPress output wins over staged public files.
 
-Root-level source favicon files named `favicon.ico`, `favicon.svg`, `favicon.png`, and `apple-touch-icon.png` are copied to the destination and auto-injected into generated HTML `<head>` output.
+Root-level public files named `favicon.ico`, `favicon.svg`, `favicon.png`, and `apple-touch-icon.png` are copied to the destination and auto-injected into generated HTML `<head>` output.
 
-The source directory must not overlap the destination directory, the selected theme directory, or the internal `.zeropress/` working directory.
+A root-level public `sitemap.xsl` is copied to the destination. When ZeroPress generates `sitemap.xml`, it auto-discovers that file and adds an XML stylesheet processing instruction for `/sitemap.xsl`.
+
+The source directory must not overlap the destination directory, the selected theme directory, or the internal `.zeropress/` working directory. An explicit public directory must be an existing dedicated directory and must not be a file, symlink, repository root, destination directory, selected theme directory, or internal `.zeropress/` working directory.
+
+If `public-dir` is inside `source`, Build Pages excludes that public subtree from Markdown page discovery.
 
 Ignored while staging and Markdown discovery:
 
@@ -254,8 +282,16 @@ title: Install ZeroPress
 description: Build a static docs site from Markdown.
 path: guides/install
 status: published
+discoverability: default
 meta:
   source: docs
+data:
+  stack:
+    - ZeroPress
+    - Cloudflare
+  facts:
+    - label: Role
+      value: Documentation
 ---
 
 Body content...
@@ -271,10 +307,31 @@ Supported front matter fields:
 | `description` | Page excerpt and description. |
 | `path` | Generated route path, such as `guides/install` for `/guides/install`. |
 | `status` | `published` includes the page. `draft` skips the page. Other values warn and skip. |
+| `discoverability` | `default`, `noindex`, or `delist`. Missing is `default`. |
 | `meta` | Optional scalar/null metadata copied to the generated page. |
+| `data` | Optional structured JSON-style data for theme-facing lists, facts, galleries, timelines, or swatches. |
 
 Unknown front matter fields are ignored to make migration from existing Markdown sites easier.
 
+`status` controls route generation. `status: draft` removes the Markdown file from generated preview-data and no HTML route is created.
+
+`discoverability` controls automatic exposure after a route is generated:
+
+- `default`: no special handling.
+- `noindex`: generate the page and add HTML robots `noindex`.
+- `delist`: generate the page, add HTML robots `noindex`, and exclude it from automatic discovery outputs such as sitemap, native search, and generated post/page listing data.
+
+`delist` is not a security or permission feature. Direct links, explicit menus, explicit collections, and body links can still expose the page.
+
+Use `meta` for small scalar flags and metadata. Use `data` when a theme should iterate structured content:
+
+```html
+{{#for fact in page.data.facts}}
+  <dt>{{fact.label}}</dt>
+  <dd>{{fact.value}}</dd>
+{{/for}}
+```
+
 ## Config
 
 Build Pages reads `<source>/.zeropress/config.json` when present. Missing config falls back to defaults.
@@ -289,12 +346,12 @@ See the public config reference at [zeropress.dev/build-pages-config](https://ze
     "title": "My Docs",
     "description": "Project documentation",
     "url": "https://example.github.io/project",
+    "expose_generator": true,
+    "search": true,
     "indexing": true,
     "footer": {
       "copyright_text": "Copyright 2026 Example Corp.",
-      "attribution": {
-        "enabled": true
-      }
+      "attribution": true
     }
   },
   "front_page": {
@@ -305,7 +362,14 @@ See the public config reference at [zeropress.dev/build-pages-config](https://ze
       "name": "Primary Menu",
       "items": [
         { "title": "Home", "url": "/" },
-        { "title": "Guide", "url": "/guide" }
+        {
+          "title": "Guide",
+          "url": "/guide",
+          "meta": {
+            "icon": "book-open",
+            "badge": "New"
+          }
+        }
       ]
     }
   },
@@ -325,19 +389,36 @@ See the public config reference at [zeropress.dev/build-pages-config](https://ze
 
 HTML front page and `custom_html` files must stay inside `.zeropress/`.
 
+Menu item `meta` is optional scalar display metadata copied into generated preview-data for themes that manually iterate menus. Use it for small values such as `icon`, `badge`, or `accent`; arrays and objects are not accepted.
+
 `site.footer.copyright_text` is rendered by the bundled docs theme when present. If it is omitted, the bundled docs theme falls back to `site.title`. ZeroPress does not add a copyright symbol automatically.
 
-The bundled docs theme shows `Published with ZeroPress.` by default. Set `site.footer.attribution.enabled` to `false` to hide it.
+The bundled docs theme shows `Published with ZeroPress.` by default. Set `site.footer.attribution` to `false` to hide it.
+
+`site.expose_generator` controls the HTML generator meta tag. Missing or `true` emits `<meta name="generator" content="ZeroPress">`; set it to `false` for white-label sites.
+
+`site.search` controls native ZeroPress search when the selected theme supports search UI. Missing or `true` enables native search for the bundled docs theme; `false` omits `/_zeropress/search.json`, `/_zeropress/search.js`, and `/_zeropress/search_pagefind.js` and hides the bundled search form.
+
+The bundled docs theme marks post/page body content with `data-pagefind-body`. If you run Pagefind after the ZeroPress build, keep the theme UI pointed at `/_zeropress/search.js` and replace the native adapter:
+
+```bash
+npx pagefind@latest \
+  --site ./_site \
+  --output-subdir _zeropress/pagefind
+
+cp ./_site/_zeropress/search_pagefind.js ./_site/_zeropress/search.js
+rm ./_site/_zeropress/search.json
+```
 
-`site.indexing` controls only the generated fallback `robots.txt`. Missing or `true` allows indexing; `false` writes `User-agent: *` / `Disallow: /`. If the source directory contains `robots.txt`, that file is copied as-is and takes priority over `site.indexing`. ZeroPress does not append a `Sitemap` directive to a source-provided `robots.txt`; add `Sitemap: https://example.com/sitemap.xml` manually when needed.
+`site.indexing` controls only the generated fallback `robots.txt`. Missing or `true` allows indexing; `false` writes `User-agent: *` / `Disallow: /`. If the public directory contains `robots.txt`, that file is copied as-is and takes priority over `site.indexing`. ZeroPress does not append a `Sitemap` directive to a public `robots.txt`; add `Sitemap: https://example.com/sitemap.xml` manually when needed.
 
 Schemas:
 
 - [ZeroPress Build Pages Config v0.1](https://zeropress.dev/schemas/zeropress-build-pages.config.v0.1.schema.json)
 
-## Internal `.zeropress/` Files
+## Workspace Internal `.zeropress/` Files
 
-Build Pages writes internal working files to `.zeropress/` in the current working directory. These files are not the final deploy output. The final static site is written to the `destination` directory.
+Build Pages reads optional site config from `<source>/.zeropress/config.json`. Separately, it writes internal working files to `.zeropress/` in the current working directory. These generated working files are not the final deploy output. The final static site is written to the `destination` directory.
 
 ```txt
 .zeropress/
@@ -351,13 +432,13 @@ Build Pages writes internal working files to `.zeropress/` in the current workin
 
 `preview-data.json` is an internal generated build input for the ZeroPress renderer. Most users do not need to edit or understand this file.
 
-`build-report.json` records discovered Markdown counts, skipped Markdown files, front page resolution, source Markdown copy policy, and custom HTML slots.
+`build-report.json` records source/public roots, discovered Markdown counts, skipped Markdown files, front page resolution, source Markdown copy policy, and custom HTML slots.
 
 `public-assets/` is a temporary staged public root used before the final ZeroPress render.
 
 ## Destination Output
 
-The `destination` directory contains the deployable static site. It includes generated ZeroPress HTML, copied public files, and original Markdown files unless Markdown source copy is disabled or files are excluded by the public passthrough rules. A source `robots.txt` is copied as a site-owned policy file; otherwise ZeroPress writes a fallback `robots.txt` with a sitemap directive when `site.url` is available. Root-level source favicon files are copied and represented as generated HTML head links.
+The `destination` directory contains the deployable static site. It includes generated ZeroPress HTML, copied public files, and original Markdown files unless Markdown source copy is disabled or files are excluded by the public passthrough rules. A public `robots.txt` is copied as a site-owned policy file; otherwise ZeroPress writes a fallback `robots.txt` with a sitemap directive when `site.url` is available. Root-level public favicon files are copied and represented as generated HTML head links. A root-level public `sitemap.xsl` is copied and linked from generated `sitemap.xml`.
 
 ## Demo
 

package/action.yml

@@ -9,6 +9,9 @@ inputs:
     description: Dedicated source directory containing Markdown files and optional .zeropress/config.json. Repository root source is not supported.
     required: false
     default: ./docs
+  public-dir:
+    description: Public passthrough directory for site-owned assets. Defaults to source.
+    required: false
   destination:
     description: Output directory for the generated static site.
     required: false