@zeropress/build-pages 0.5.2 → 0.5.5

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.
 
@@ -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.
 
@@ -138,42 +183,37 @@ The CLI requires explicit input and output paths. The GitHub Action keeps safe d
 
 | Option | Default | Purpose |
 | --- | --- | --- |
-| `--source <dir>` | required | Source directory containing Markdown and public files |
+| `--source <dir>` | required | Dedicated source directory containing Markdown and public files |
 | `--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 |
-| `--no-check-links` | false | Skip link checking |
-
-Equivalent environment variables:
-
-| Env | Maps to |
-| --- | --- |
-| `ZEROPRESS_PUBLIC_DIR` | `--source` |
-| `ZEROPRESS_OUT_DIR` | `--destination` |
-| `ZEROPRESS_THEME_DIR` | `--theme-path` |
-| `ZEROPRESS_BUILD_PAGES_CONFIG` | `--config` |
-| `ZEROPRESS_SITE_URL` | `--site-url` |
-| `ZEROPRESS_SKIP_UNTITLED_MARKDOWN=true` | `--skip-untitled-markdown` |
-
-CLI options take precedence over environment variables.
+| `--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` or `ZEROPRESS_PUBLIC_DIR`.
+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.
 
 ```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`, so `--source ./` and `--destination ./_site` are supported when you intentionally want to build from the repository root. 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.
+
+The source directory must not overlap the destination directory, the selected theme directory, or the internal `.zeropress/` working directory.
 
 Ignored while staging and Markdown discovery:
 
@@ -201,7 +241,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:
 
@@ -236,6 +277,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",
@@ -285,12 +328,11 @@ The bundled docs theme shows `Published with ZeroPress.` by default. Set `site.f
 
 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)
 
-## Generated Files
+## Internal `.zeropress/` Files
 
-Build Pages writes:
+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.
 
 ```txt
 .zeropress/
@@ -300,14 +342,18 @@ Build Pages writes:
   public-assets/
 ```
 
-`build-pages-config.json` is the resolved user-facing Build Pages config used for the current run. It combines `.zeropress/config.json`, defaults, and CLI/env overrides where applicable.
+`build-pages-config.json` is the resolved user-facing Build Pages config used for the current run. It combines source config, defaults, and CLI or Action input overrides where applicable.
 
 `preview-data.json` is an internal generated build input for the ZeroPress renderer. Most users do not need to edit or understand this file.
 
-## Development
+`build-report.json` records discovered Markdown counts, skipped Markdown files, front page resolution, source Markdown copy policy, and custom HTML slots.
 
-```bash
-npm install
-npm run build:action
-npm test
-```
+`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.
+
+## Demo
+
+- [zeropress.dev](https://github.com/zeropress-app/zeropress.dev) is built with `@zeropress/build-pages`.

package/action.yml

@@ -6,7 +6,7 @@ branding:
   color: blue
 inputs:
   source:
-    description: Source directory containing Markdown files and optional .zeropress/config.json.
+    description: Dedicated source directory containing Markdown files and optional .zeropress/config.json. Repository root source is not supported.
     required: false
     default: ./docs
   destination:
@@ -27,11 +27,15 @@ inputs:
     description: Canonical site URL override.
     required: false
   skip-untitled-markdown:
-    description: Skip Markdown files without an H1 instead of failing.
+    description: Skip Markdown files without a page title instead of failing.
     required: false
     default: "false"
-  check-links:
-    description: Warn about broken internal links after build.
+  skip-link-check:
+    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:

package/dist/action.js

@@ -1,4 +1,6 @@
 #!/usr/bin/env node
+import { createRequire as __zeropressCreateRequire } from "node:module";
+const require = __zeropressCreateRequire(import.meta.url);
 var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -62137,18 +62139,26 @@ async function linkExists(siteDir, link2) {
 // src/index.js
 var __dirname = path3.dirname(fileURLToPath(import.meta.url));
 var packageDir = path3.resolve(__dirname, "..");
-var prebuildScript = path3.join(packageDir, "src", "prebuild.js");
+var prebuildScript = __dirname === path3.join(packageDir, "dist") ? path3.join(__dirname, "prebuild.js") : path3.join(packageDir, "src", "prebuild.js");
 var PREVIEW_DATA_PATH = ".zeropress/preview-data.json";
 var STAGING_DIR = ".zeropress/public-assets";
 var DEFAULT_THEME = "docs";
 async function runBuildPages(options2) {
   const cwd = path3.resolve(options2.cwd || process.cwd());
+  const copyMarkdownSource = options2.copyMarkdownSource !== false;
   const sourceDir = path3.resolve(cwd, options2.source);
   const destinationDir = path3.resolve(cwd, options2.destination);
   const generatedDir = path3.join(cwd, ".zeropress");
   const stagingDir = path3.join(cwd, STAGING_DIR);
   const previewDataPath = path3.join(cwd, PREVIEW_DATA_PATH);
   const themeDir = resolveThemeDir(cwd, options2);
+  assertBuildPagesPathLayout({
+    cwd,
+    sourceDir,
+    destinationDir,
+    themeDir,
+    generatedDir
+  });
   await assertDirectory(sourceDir, "Source directory");
   await fs3.rm(generatedDir, { recursive: true, force: true });
   await fs3.mkdir(generatedDir, { recursive: true });
@@ -62156,7 +62166,8 @@ async function runBuildPages(options2) {
     ...process.env,
     ZEROPRESS_BUILD_PAGES_SOURCE: sourceDir,
     ZEROPRESS_PUBLIC_DIR: sourceDir,
-    ZEROPRESS_SKIP_UNTITLED_MARKDOWN: String(Boolean(options2.skipUntitledMarkdown))
+    ZEROPRESS_SKIP_UNTITLED_MARKDOWN: String(Boolean(options2.skipUntitledMarkdown)),
+    ZEROPRESS_COPY_MARKDOWN_SOURCE: String(copyMarkdownSource)
   };
   if (options2.config) {
     env.ZEROPRESS_BUILD_PAGES_CONFIG = path3.resolve(cwd, options2.config);
@@ -62179,7 +62190,8 @@ async function runBuildPages(options2) {
   await fs3.rm(stagingDir, { recursive: true, force: true });
   await fs3.mkdir(stagingDir, { recursive: true });
   await copyPublicStaging(sourceDir, stagingDir, {
-    excludePaths: [destinationDir, themeDir, generatedDir]
+    excludePaths: [destinationDir, themeDir, generatedDir],
+    copyMarkdownSource
   });
   const previousPublicDir = process.env.ZEROPRESS_PUBLIC_DIR;
   process.env.ZEROPRESS_PUBLIC_DIR = stagingDir;
@@ -62195,7 +62207,7 @@ async function runBuildPages(options2) {
       process.env.ZEROPRESS_PUBLIC_DIR = previousPublicDir;
     }
   }
-  if (options2.checkLinks) {
+  if (!options2.skipLinkCheck) {
     const result = await checkInternalLinks(destinationDir);
     if (result.brokenLinks.length) {
       console.warn("Warning: broken internal links found:");
@@ -62229,6 +62241,26 @@ async function assertDirectory(dir, label) {
     throw new Error(`${label} is not a directory: ${dir}`);
   }
 }
+function assertBuildPagesPathLayout({ cwd, sourceDir, destinationDir, themeDir, generatedDir }) {
+  if (samePath(sourceDir, cwd)) {
+    throw new Error(
+      `Source directory must be a dedicated content directory, not the current working directory. Received: ${formatPath(cwd, sourceDir)}`
+    );
+  }
+  assertNoPathOverlap(cwd, "Source directory", sourceDir, "internal .zeropress working directory", generatedDir);
+  assertNoPathOverlap(cwd, "Destination directory", destinationDir, "internal .zeropress working directory", generatedDir);
+  assertNoPathOverlap(cwd, "Theme directory", themeDir, "internal .zeropress working directory", generatedDir);
+  assertNoPathOverlap(cwd, "Source directory", sourceDir, "destination directory", destinationDir);
+  assertNoPathOverlap(cwd, "Source directory", sourceDir, "theme directory", themeDir);
+}
+function assertNoPathOverlap(cwd, firstLabel, firstPath, secondLabel, secondPath) {
+  if (!pathsOverlap2(firstPath, secondPath)) {
+    return;
+  }
+  throw new Error(
+    `${firstLabel} must not overlap the ${secondLabel}. ${firstLabel}: ${formatPath(cwd, firstPath)}; ${secondLabel}: ${formatPath(cwd, secondPath)}`
+  );
+}
 async function copyPublicStaging(sourceDir, targetDir, options2) {
   const entries = await fs3.readdir(sourceDir, { withFileTypes: true });
   for (const entry of entries) {
@@ -62248,6 +62280,9 @@ async function copyPublicStaging(sourceDir, targetDir, options2) {
     if (!entry.isFile()) {
       continue;
     }
+    if (options2.copyMarkdownSource === false && entry.name.toLowerCase().endsWith(".md")) {
+      continue;
+    }
     await fs3.mkdir(path3.dirname(targetPath), { recursive: true });
     await fs3.copyFile(sourcePath, targetPath);
   }
@@ -62265,6 +62300,9 @@ function pathsOverlap2(firstPath, secondPath) {
   const second = path3.resolve(secondPath);
   return first === second || isPathInside2(first, second) || isPathInside2(second, first);
 }
+function samePath(firstPath, secondPath) {
+  return path3.resolve(firstPath) === path3.resolve(secondPath);
+}
 function isPathInside2(parentPath, childPath) {
   const relativePath = path3.relative(parentPath, childPath);
   return Boolean(relativePath) && !relativePath.startsWith("..") && !path3.isAbsolute(relativePath);
@@ -62283,7 +62321,8 @@ var options = {
   config: input("config"),
   siteUrl: input("site-url"),
   skipUntitledMarkdown: booleanInput("skip-untitled-markdown", false),
-  checkLinks: booleanInput("check-links", true)
+  skipLinkCheck: booleanInput("skip-link-check", false),
+  copyMarkdownSource: falseOnlyInput("copy-markdown-source")
 };
 try {
   await runBuildPages(options);
@@ -62302,3 +62341,6 @@ function booleanInput(name, fallback) {
   }
   return value.toLowerCase() === "true";
 }
+function falseOnlyInput(name) {
+  return input(name).toLowerCase() !== "false";
+}