@zeropress/build-pages 0.6.1 → 0.6.3

package/src/prebuild.js

@@ -6,6 +6,7 @@ import matter from 'gray-matter';
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const rootDir = process.cwd();
 const sourceDir = resolveEnvPath(['ZEROPRESS_BUILD_PAGES_SOURCE'], 'docs');
+const publicDir = resolveEnvPath(['ZEROPRESS_BUILD_PAGES_PUBLIC_DIR'], sourceDir);
 const defaultConfigPath = path.join(sourceDir, '.zeropress', 'config.json');
 const configPath = resolveOptionalEnvPath(['ZEROPRESS_BUILD_PAGES_CONFIG'], defaultConfigPath);
 const outDir = path.join(rootDir, '.zeropress');
@@ -15,13 +16,14 @@ const buildReportPath = path.join(outDir, 'build-report.json');
 const skipUntitledMarkdown = readBooleanEnv('ZEROPRESS_SKIP_UNTITLED_MARKDOWN');
 const copyMarkdownSource = readBooleanEnv('ZEROPRESS_COPY_MARKDOWN_SOURCE', true);
 const FRONT_PAGE_TYPES = new Set(['theme_index', 'markdown', 'html']);
-const BUILD_PAGES_CONFIG_SCHEMA_URL = 'https://zeropress.dev/schemas/zeropress-build-pages.config.v0.1.schema.json';
-const PREVIEW_DATA_SCHEMA_URL = 'https://zeropress.dev/schemas/preview-data.v0.6.schema.json';
+const BUILD_PAGES_CONFIG_SCHEMA_URL = 'https://schemas.zeropress.dev/build-pages-config/v0.1/schema.json';
+const PREVIEW_DATA_SCHEMA_URL = 'https://schemas.zeropress.dev/preview-data/v0.6/schema.json';
 const FRONT_MATTER_DATA_KEY_PATTERN = /^[a-zA-Z_][a-zA-Z0-9_]*(?:-[a-zA-Z0-9_]+)*$/;
 const FRONT_MATTER_DATA_MAX_DEPTH = 4;
 const FRONT_MATTER_DATA_MAX_KEYS = 64;
 const FRONT_MATTER_DATA_MAX_ARRAY_LENGTH = 256;
 const FRONT_MATTER_DISCOVERABILITY_VALUES = new Set(['default', 'noindex', 'delist']);
+const markdownDiscoverExcludeRoots = buildMarkdownDiscoverExcludeRoots();
 
 class PrebuildMarkdownError extends Error {
   constructor(sourcePath, reason, expected = '', code = 'invalid_markdown') {
@@ -230,7 +232,7 @@ function buildSiteData(config, frontPage) {
     description: configuredSite.description,
     url: configuredSite.url,
     media_base_url: '',
-    locale: 'en-US',
+    locale: configuredSite.locale,
     posts_per_page: 10,
     datetime_display: 'static',
     date_style: 'medium',
@@ -243,9 +245,18 @@ function buildSiteData(config, frontPage) {
     },
     disallow_comments: true,
     expose_generator: configuredSite.expose_generator !== false,
+    search: configuredSite.search !== false,
     indexing: configuredSite.indexing !== false,
   };
 
+  if (configuredSite.logo) {
+    site.logo = configuredSite.logo;
+  }
+
+  if (configuredSite.meta !== undefined) {
+    site.meta = configuredSite.meta;
+  }
+
   if (configuredSite.footer) {
     site.footer = configuredSite.footer;
   }
@@ -278,23 +289,98 @@ function normalizeSiteConfig(value) {
   }
 
   const configuredSite = isPlainObject(value) ? value : {};
-  assertKnownConfigKeys(configuredSite, ['title', 'description', 'url', 'expose_generator', 'indexing', 'footer'], 'site');
+  assertKnownConfigKeys(configuredSite, ['title', 'description', 'url', 'logo', 'locale', 'expose_generator', 'search', 'indexing', 'footer', 'meta'], 'site');
   const site = {
     title: readConfigString(configuredSite.title, 'Documentation'),
     description: readConfigString(configuredSite.description, 'A documentation site.'),
     url: readEnv('ZEROPRESS_SITE_URL', readConfigString(configuredSite.url, '')),
+    locale: normalizeSiteLocale(configuredSite.locale),
     expose_generator: readConfigBoolean(configuredSite.expose_generator, true, 'site.expose_generator'),
+    search: readConfigBoolean(configuredSite.search, true, 'site.search'),
     indexing: readConfigBoolean(configuredSite.indexing, true, 'site.indexing'),
   };
 
+  const logo = normalizeSiteLogo(configuredSite.logo);
+  if (logo) {
+    site.logo = logo;
+  }
+
   const footer = normalizeFooter(configuredSite.footer);
   if (footer) {
     site.footer = footer;
   }
 
+  if (configuredSite.meta !== undefined) {
+    site.meta = normalizeSiteMeta(configuredSite.meta, 'site.meta');
+  }
+
   return site;
 }
 
+function normalizeSiteLocale(value) {
+  if (value === undefined) {
+    return 'en-US';
+  }
+  if (typeof value !== 'string') {
+    throw new PrebuildConfigError('site.locale must be a string when provided.');
+  }
+
+  const locale = value.trim();
+  if (locale.length < 2) {
+    throw new PrebuildConfigError('site.locale must be a non-empty locale string such as "en-US" or "ko-KR".');
+  }
+
+  return locale;
+}
+
+function normalizeSiteLogo(value) {
+  if (value === undefined) {
+    return undefined;
+  }
+  if (!isPlainObject(value)) {
+    throw new PrebuildConfigError('site.logo must be an object when provided.');
+  }
+  assertKnownConfigKeys(value, ['src', 'alt'], 'site.logo');
+
+  const src = readConfigString(value.src, '');
+  if (!src) {
+    throw new PrebuildConfigError(
+      'site.logo.src must be a non-empty URL-like string.',
+      '  "logo": { "src": "/logo.svg", "alt": "My Site" }',
+    );
+  }
+  validateUrlLikeString(src, 'site.logo.src');
+
+  const logo = { src };
+  if (value.alt !== undefined) {
+    if (typeof value.alt !== 'string') {
+      throw new PrebuildConfigError('site.logo.alt must be a string when provided.');
+    }
+    const alt = value.alt.trim();
+    if (alt) {
+      logo.alt = alt;
+    }
+  }
+
+  return logo;
+}
+
+function normalizeSiteMeta(value, pathLabel) {
+  if (!isPlainObject(value)) {
+    throw new PrebuildConfigError(`${pathLabel} must be an object when provided.`);
+  }
+
+  const meta = {};
+  for (const [key, metaValue] of Object.entries(value)) {
+    if (!isPreviewMetaValue(metaValue)) {
+      throw new PrebuildConfigError(`${pathLabel}.${key} must be a string, number, boolean, or null.`);
+    }
+    meta[key] = metaValue;
+  }
+
+  return meta;
+}
+
 function normalizeFooter(value) {
   if (value === undefined) {
     return undefined;
@@ -320,6 +406,25 @@ function normalizeFooter(value) {
   return Object.keys(footer).length ? footer : undefined;
 }
 
+function validateUrlLikeString(value, pathLabel) {
+  if (value.startsWith('//')) {
+    throw new PrebuildConfigError(`${pathLabel} must be an absolute URL or a safe relative path.`);
+  }
+
+  if (value.startsWith('/') || value.startsWith('./') || value.startsWith('../')) {
+    return;
+  }
+
+  try {
+    const url = new URL(value);
+    if (!url.protocol || !url.hostname) {
+      throw new Error('missing host');
+    }
+  } catch {
+    throw new PrebuildConfigError(`${pathLabel} must be an absolute URL or a safe relative path.`);
+  }
+}
+
 function readConfigBoolean(value, fallback, pathName) {
   if (value === undefined) {
     return fallback;
@@ -760,6 +865,7 @@ function buildPrebuildReport({
   return {
     generated_at: new Date().toISOString(),
     source_dir: formatSourcePath(sourceDir),
+    public_dir: formatSourcePath(publicDir),
     config_path: formatSourcePath(configPath),
     build_pages_config_path: formatSourcePath(buildPagesConfigPath),
     preview_data_path: formatSourcePath(previewDataPath),
@@ -786,7 +892,8 @@ function buildPrebuildReport({
 function printPrebuildSummary(report) {
   const lines = [
     'ZeroPress build report',
-    `- Public root: ${report.source_dir}`,
+    `- Source root: ${report.source_dir}`,
+    `- Public root: ${report.public_dir}`,
     `- Markdown discovered: ${report.markdown.discovered}`,
     `- Markdown pages generated: ${report.markdown.generated_pages}`,
     `- Markdown skipped: ${report.markdown.skipped}`,
@@ -1134,6 +1241,10 @@ async function listMarkdownFiles(dir) {
     }
 
     const entryPath = path.join(dir, entry.name);
+    if (isMarkdownDiscoverExcluded(entryPath)) {
+      continue;
+    }
+
     if (entry.isDirectory()) {
       files.push(...await listMarkdownFiles(entryPath));
       continue;
@@ -1147,6 +1258,24 @@ async function listMarkdownFiles(dir) {
   return files.sort((left, right) => left.localeCompare(right));
 }
 
+function buildMarkdownDiscoverExcludeRoots() {
+  if (samePath(sourceDir, publicDir) || !isPathInside(sourceDir, publicDir)) {
+    return [];
+  }
+
+  return [publicDir];
+}
+
+function isMarkdownDiscoverExcluded(entryPath) {
+  return markdownDiscoverExcludeRoots.some((excludeRoot) => (
+    samePath(entryPath, excludeRoot) || isPathInside(excludeRoot, entryPath)
+  ));
+}
+
+function samePath(firstPath, secondPath) {
+  return path.resolve(firstPath) === path.resolve(secondPath);
+}
+
 function shouldIgnoreMarkdownDiscoverEntry(name) {
   const basename = String(name || '');
   const lowerName = basename.toLowerCase();

package/themes/docs/404.html

@@ -1,6 +1,17 @@
 <section class="shell not-found">
-  <p class="eyebrow">404</p>
+  <p class="eyebrow eyebrow--error">
+    <span class="eyebrow__dot" aria-hidden="true"></span>
+    404
+  </p>
   <h1>Page not found</h1>
   <p class="lede">The page you are looking for is not part of the current documentation build.</p>
-  <a class="button-link" href="/">Return home</a>
+  <div class="hero__actions">
+    <a class="button-link" href="/">
+      Return home
+      <svg viewBox="0 0 24 24" width="16" height="16" fill="none" stroke="currentColor" stroke-width="2.2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true">
+        <line x1="5" y1="12" x2="19" y2="12"></line>
+        <polyline points="12 5 19 12 12 19"></polyline>
+      </svg>
+    </a>
+  </div>
 </section>