@zeropress/build-pages 0.5.4 → 0.5.6

package/README.md

@@ -1,8 +1,11 @@
 # @zeropress/build-pages
 
+![npm](https://img.shields.io/npm/v/%40zeropress%2Fbuild-pages)
+![license](https://img.shields.io/npm/l/%40zeropress%2Fbuild-pages)
+
 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`.
+`@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).
 
 The generated output is plain static files that can be deployed to GitHub Pages, Cloudflare Pages, Netlify, Vercel, or any static hosting provider.
 
@@ -46,7 +49,7 @@ flowchart TD
   output --> html["HTML pages"]
   output --> assets["Theme assets"]
   output --> copied["Copied public files"]
-  output --> special["sitemap.xml / robots.txt / feed.xml"]
+  output --> special["sitemap.xml / fallback robots.txt / feed.xml"]
 ```
 
 ## Usage
@@ -97,10 +100,52 @@ jobs:
 
 The action `zeropress-build-pages` builds the static files only. Uploading and deploying are handled by your hosting provider's deployment action or CLI.
 
+Minimal action usage:
+
+```yaml
+- name: Build ZeroPress Pages
+  uses: zeropress-app/zeropress-build-pages@v0
+```
+
+That is equivalent to:
+
+```yaml
+- name: Build ZeroPress Pages
+  uses: zeropress-app/zeropress-build-pages@v0
+  with:
+    source: ./docs
+    destination: ./_site
+    theme: docs
+    skip-untitled-markdown: false
+    skip-link-check: false
+    copy-markdown-source: true
+```
+
+Custom input example:
+
+```yaml
+- name: Build ZeroPress Pages
+  uses: zeropress-app/zeropress-build-pages@v0
+  with:
+    source: ./documents
+    destination: ./_site
+    theme-path: ./theme-docs
+    config: ./documents/.zeropress/config.json
+    site-url: https://example.com/docs
+    copy-markdown-source: false
+```
+
 In the action inputs:
 
 - `source` is the directory that contains your Markdown pages, public files, and optional `.zeropress/config.json`. The default is `./docs`.
 - `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`.
+- `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.
 
@@ -146,23 +191,29 @@ The CLI requires explicit input and output paths. The GitHub Action keeps safe d
 | `--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 |
+| `--no-copy-markdown-source` | `false` | Do not copy original Markdown files to output |
 
 ## Source Tree
 
-The source directory 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. It is both the Markdown source root and the public passthrough root. GitHub Action usage defaults to `./docs`; CLI usage requires `--source`.
 
-Use a dedicated content directory such as `docs/` or `documents/`. Repository root source (`--source ./`) is not supported, because Build Pages uses `.zeropress/` in the current working directory for internal working files.
+Use a dedicated content directory such as `docs/` or `documents/`. Repository root source (`--source ./`) is not supported.
 
 ```txt
-docs/
-  index.md
-  guide.md
-  assets/
-  .zeropress/
-    config.json
+my-site/
+  docs/                 # source
+    index.md
+    guide.md
+    assets/
+      logo.png
+    .zeropress/
+      config.json
+  _site/                # destination, generated
 ```
 
-Build Pages stages the source tree before calling `@zeropress/build`. Generated ZeroPress output wins over staged public files.
+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.
+
+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.
 
 The source directory must not overlap the destination directory, the selected theme directory, or the internal `.zeropress/` working directory.
 
@@ -192,7 +243,8 @@ Additional Markdown discovery ignores:
 - Nested `index.md` maps to a directory route, such as `cli/index.md` -> `/cli/`.
 - Other Markdown files map to extensionless routes, such as `cli/tool.md` -> `/cli/tool`.
 - Markdown links to other discovered `.md` files are rewritten to generated public URLs.
-- Original Markdown files remain available as public passthrough files.
+- Original Markdown files remain available as public passthrough files by default.
+- Use `--no-copy-markdown-source` or Action input `copy-markdown-source: false` to keep source Markdown out of the generated output. This also hides bundled theme `View this page as Markdown` links.
 
 Optional YAML front matter is supported at the top of Markdown files:
 
@@ -227,6 +279,8 @@ Unknown front matter fields are ignored to make migration from existing Markdown
 
 Build Pages reads `<source>/.zeropress/config.json` when present. Missing config falls back to defaults.
 
+See the public config reference at [zeropress.dev/build-pages-config](https://zeropress.dev/build-pages-config/).
+
 ```json
 {
   "$schema": "https://zeropress.dev/schemas/zeropress-build-pages.config.v0.1.schema.json",
@@ -235,6 +289,7 @@ Build Pages reads `<source>/.zeropress/config.json` when present. Missing config
     "title": "My Docs",
     "description": "Project documentation",
     "url": "https://example.github.io/project",
+    "indexing": true,
     "footer": {
       "copyright_text": "Copyright 2026 Example Corp.",
       "attribution": {
@@ -274,10 +329,11 @@ HTML front page and `custom_html` files must stay inside `.zeropress/`.
 
 The bundled docs theme shows `Published with ZeroPress.` by default. Set `site.footer.attribution.enabled` to `false` to hide it.
 
+`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.
+
 Schemas:
 
-- `schemas/zeropress-build-pages.config.v0.1.schema.json`
-- `schemas/zeropress-build-pages.config.schema.json`
+- [ZeroPress Build Pages Config v0.1](https://zeropress.dev/schemas/zeropress-build-pages.config.v0.1.schema.json)
 
 ## Internal `.zeropress/` Files
 
@@ -295,18 +351,14 @@ 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, and custom HTML slots.
+`build-report.json` records 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 they are excluded by the public passthrough rules.
+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.
 
-## Development
+## Demo
 
-```bash
-npm install
-npm run build:action
-npm test
-```
+- [zeropress.dev](https://github.com/zeropress-app/zeropress.dev) is built with `@zeropress/build-pages`.

package/action.yml

@@ -34,6 +34,10 @@ inputs:
     description: Skip internal link checking after the site is built.
     required: false
     default: "false"
+  copy-markdown-source:
+    description: Copy original Markdown files to output and expose View this page as Markdown links.
+    required: false
+    default: "true"
 runs:
   using: node24
   main: dist/action.js