create-zudo-doc 0.2.12 → 0.2.14

package/dist/cli.d.ts

@@ -27,6 +27,7 @@ export interface CliArgs {
     tagGovernance?: boolean;
     footerTaglist?: boolean;
     bodyFootUtil?: boolean;
+    noindex?: boolean;
     githubUrl?: string;
     preset?: string;
     pm?: "pnpm" | "npm" | "yarn" | "bun";

package/dist/constants.js

@@ -234,6 +234,13 @@ export const FEATURES = [
         default: false,
         cliFlag: "footer-taglist",
     },
+    {
+        value: "noindex",
+        label: "Avoid robots indexing",
+        hint: "Keep search engines out (noindex meta + robots.txt)",
+        default: false,
+        cliFlag: "noindex",
+    },
 ];
 // Display labels for header-right items. Keys are canonical component/trigger
 // names from HeaderRightComponentName / HeaderRightTriggerName

package/dist/scaffold.js

@@ -39,26 +39,110 @@ function shouldCopyBaseFile(srcAbs, baseDir) {
     return true;
 }
 const STARTER_CONTENT_EN = (siteName) => `---
-title: Welcome
+title: Getting Started
 sidebar_position: 1
 ---
 
-# Welcome to ${siteName}
+Welcome to ${siteName}. Choose a topic below to get started.
 
-This documentation site was created with [zudo-doc](https://github.com/zudolab/zudo-doc).
+<CategoryNav category="getting-started" />
+`;
+const STARTER_CONTENT_JA = () => `---
+title: はじめに
+sidebar_position: 1
+---
 
-## Getting Started
+ドキュメントへようこそ。以下のトピックから始めてください。
 
-Edit the files in \`src/content/docs/\` to add your documentation.
+<CategoryNav category="getting-started" />
 `;
-const STARTER_CONTENT_JA = () => `---
-title: ようこそ
+const STARTER_CHILD_INTRODUCTION_EN = (siteName) => `---
+title: Introduction
 sidebar_position: 1
 ---
 
-# ようこそ
+## What is ${siteName}?
+
+${siteName} is a documentation site built with [zudo-doc](https://github.com/zudolab/zudo-doc), a minimal documentation framework powered by zfb, MDX, and Tailwind CSS.
+
+## Key Features
+
+- MDX authoring with rich component support
+- Fast static site generation via zfb
+- Tailwind CSS v4 for styling
+- Optional i18n, search, and more
+`;
+const STARTER_CHILD_INTRODUCTION_JA = (siteName) => `---
+title: はじめに
+sidebar_position: 1
+---
+
+## ${siteName} とは？
+
+${siteName} は [zudo-doc](https://github.com/zudolab/zudo-doc) で構築されたドキュメントサイトです。zfb・MDX・Tailwind CSS を使ったミニマルなドキュメントフレームワークです。
+
+## 主な機能
+
+- MDX によるリッチなコンポーネントサポート
+- zfb による高速な静的サイト生成
+- スタイリングには Tailwind CSS v4
+- i18n・検索などオプション機能も充実
+`;
+const STARTER_CHILD_INSTALLATION_EN = () => `---
+title: Installation
+sidebar_position: 2
+---
+
+## Requirements
+
+- Node.js 18 or later
+- pnpm (recommended), npm, yarn, or bun
+
+## Create a New Project
+
+Run the scaffolding tool to create a new project:
+
+\`\`\`sh
+pnpm create zudo-doc my-docs
+\`\`\`
+
+## Start the Dev Server
+
+\`\`\`sh
+cd my-docs
+pnpm install
+pnpm dev
+\`\`\`
+
+Open [http://localhost:4321](http://localhost:4321) to view your docs.
+`;
+const STARTER_CHILD_INSTALLATION_JA = () => `---
+title: インストール
+sidebar_position: 2
+---
+
+## 動作要件
+
+- Node.js 18 以降
+- pnpm（推奨）、npm、yarn、または bun
+
+## 新しいプロジェクトを作成する
+
+スキャフォールドツールを実行して新しいプロジェクトを作成します：
+
+\`\`\`sh
+pnpm create zudo-doc my-docs
+\`\`\`
+
+## 開発サーバーを起動する
+
+\`\`\`sh
+cd my-docs
+pnpm install
+pnpm dev
+\`\`\`
 
-このドキュメントサイトは [zudo-doc](https://github.com/zudolab/zudo-doc) で作成されました。
+[http://localhost:4321](http://localhost:4321) を開いてドキュメントを確認してください。
 `;
 const CHANGELOG_CONTENT_EN = () => `---
 title: Changelog
@@ -149,6 +233,15 @@ export async function scaffold(choices) {
         ? STARTER_CONTENT_JA()
         : STARTER_CONTENT_EN(escapedName);
     await fs.outputFile(path.join(targetDir, "src/content/docs/getting-started/index.mdx"), primaryContent);
+    // Primary language child docs under getting-started/
+    const primaryIntroductionContent = defaultLang === "ja"
+        ? STARTER_CHILD_INTRODUCTION_JA(escapedName)
+        : STARTER_CHILD_INTRODUCTION_EN(escapedName);
+    await fs.outputFile(path.join(targetDir, "src/content/docs/getting-started/introduction.mdx"), primaryIntroductionContent);
+    const primaryInstallationContent = defaultLang === "ja"
+        ? STARTER_CHILD_INSTALLATION_JA()
+        : STARTER_CHILD_INSTALLATION_EN();
+    await fs.outputFile(path.join(targetDir, "src/content/docs/getting-started/installation.mdx"), primaryInstallationContent);
     // When i18n is ON, place secondary language content
     if (choices.features.includes("i18n")) {
         const secondaryLang = getSecondaryLang(defaultLang);
@@ -158,6 +251,15 @@ export async function scaffold(choices) {
             ? STARTER_CONTENT_JA()
             : STARTER_CONTENT_EN(escapedName);
         await fs.outputFile(path.join(targetDir, `${secondaryDir}/getting-started/index.mdx`), secondaryContent);
+        // Secondary language child docs under getting-started/
+        const secondaryIntroductionContent = secondaryLang === "ja"
+            ? STARTER_CHILD_INTRODUCTION_JA(escapedName)
+            : STARTER_CHILD_INTRODUCTION_EN(escapedName);
+        await fs.outputFile(path.join(targetDir, `${secondaryDir}/getting-started/introduction.mdx`), secondaryIntroductionContent);
+        const secondaryInstallationContent = secondaryLang === "ja"
+            ? STARTER_CHILD_INSTALLATION_JA()
+            : STARTER_CHILD_INSTALLATION_EN();
+        await fs.outputFile(path.join(targetDir, `${secondaryDir}/getting-started/installation.mdx`), secondaryInstallationContent);
     }
     // When changelog is ON, create a starter changelog page
     if (choices.features.includes("changelog")) {
@@ -333,16 +435,19 @@ function generatePackageJson(choices) {
         // "@takazudo/zfb" (#972) — plus removal of the no-op linkValidation.allowExternal
         // knob (#925); both are non-breaking for a fresh scaffold. A fresh scaffold
         // sets no explicit codeHighlight.theme so the default still applies. No
-        // consumer-facing / CLI breaking change. next.52 (current pin): adds the
+        // consumer-facing / CLI breaking change. next.52: adds the
         // `ClientRouter({ preserveHtmlAttrs })` option (zfb#1104) — consumers can
         // declare runtime `<html>` attribute names to preserve across SPA swaps so
         // e.g. `data-sidebar-hidden` / `data-theme` survive (zudolab/zudo-doc#2200).
-        // Additive, non-breaking for a fresh scaffold.
-        "@takazudo/zfb": "0.1.0-next.52",
-        "@takazudo/zfb-runtime": "0.1.0-next.52",
+        // Additive, non-breaking for a fresh scaffold. next.53 (current pin):
+        // zfb-content GFM-autolink fix — terminate the autolink path at CJK
+        // boundaries (zfb#1105). Content-rendering bug fix, additive; relevant for
+        // CJK (e.g. Japanese) docs. No consumer-facing / CLI breaking change.
+        "@takazudo/zfb": "0.1.0-next.53",
+        "@takazudo/zfb-runtime": "0.1.0-next.53",
         // zfb-adapter-cloudflare — required for any route with `prerender = false`.
         // Pinned in lockstep with @takazudo/zfb.
-        "@takazudo/zfb-adapter-cloudflare": "0.1.0-next.52",
+        "@takazudo/zfb-adapter-cloudflare": "0.1.0-next.53",
         // @takazudo/zudo-doc — published from this monorepo via
         // .github/workflows/publish-zudo-doc.yml. The pin here is bumped in
         // lockstep by scripts/release-create-zudo-doc.sh whenever zudo-doc's
@@ -354,7 +459,7 @@ function generatePackageJson(choices) {
         // ties this pin to packages/zudo-doc's version, so the lockstep release
         // bumps both together; do not cut a create-zudo-doc release until the
         // matching @takazudo/zudo-doc version (with content.css) is on npm.
-        "@takazudo/zudo-doc": "^0.2.12",
+        "@takazudo/zudo-doc": "^0.2.14",
         // zod — used by the generated zfb.config.ts. zfb-config-gen emits
         // `import { z } from "zod"` for the content-collection schema +
         // `z.toJSONSchema(...)` conversion. Without this dep, the consumer
@@ -408,7 +513,7 @@ function generatePackageJson(choices) {
         // @takazudo/zudo-doc/integrations/doc-history which in turn imports
         // @takazudo/zudo-doc-history-server/git-history. Without this dep the
         // plugin host fails at init with ERR_MODULE_NOT_FOUND — W8A (#1739).
-        deps["@takazudo/zudo-doc-history-server"] = "^0.2.12";
+        deps["@takazudo/zudo-doc-history-server"] = "^0.2.14";
         // W7A (#1736): doc-history-plugin.mjs spawns `tsx -e <inline-script>` to
         // run the v2 runtime in a TS-aware Node subprocess; without tsx the
         // plugin's preBuild step exits with ENOENT before zfb finishes config

package/dist/settings-gen.js

@@ -51,7 +51,7 @@ export function generateSettingsFile(choices) {
     lines.push(`  siteDescription: "" as string,`);
     lines.push(`  base: "/",`);
     lines.push(`  trailingSlash: false as boolean,`);
-    lines.push(`  noindex: false as boolean,`);
+    lines.push(`  noindex: ${choices.features.includes("noindex")} as boolean,`);
     lines.push(`  editUrl: false as string | false,`);
     const rawGithubUrl = (choices.githubUrl ?? "").trim();
     if (rawGithubUrl) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-zudo-doc",
-  "version": "0.2.12",
+  "version": "0.2.14",
   "description": "Create a new zudo-doc documentation site",
   "license": "MIT",
   "author": "Takeshi Takatsudo",

package/templates/base/pages/lib/_header-with-defaults.tsx

@@ -311,6 +311,7 @@ export function HeaderWithDefaults(
       lang={lang}
       currentPath={currentPath}
       currentVersion={currentVersion}
+      activeCategory={navSection}
       sidebarToggle={sidebarToggle}
       themeToggle={themeToggle}
       search={searchWidget}

package/templates/base/pages/robots.txt.tsx

@@ -0,0 +1,29 @@
+// Prerendered robots.txt page route, gated by settings.noindex.
+//
+// Filename → output extension mapping (zfb convention): the
+// second-to-last `.`-separated segment of the stem becomes the output
+// extension, so `robots.txt.tsx` builds `dist/robots.txt`. The
+// explicit `contentType` export pins the dev-server Content-Type
+// header to `text/plain` regardless of the filename hint.
+
+import { settings } from "@/config/settings";
+
+export const frontmatter = { title: "Robots" };
+export const contentType = "text/plain";
+
+export default function Robots(): string {
+  if (settings.noindex) {
+    // noindex: disallow all crawlers. Omit Sitemap: — advertising a sitemap
+    // while disallowing all crawlers is contradictory.
+    return `User-agent: *\nDisallow: /\n`;
+  }
+
+  const siteUrlBase = (settings.siteUrl ?? "").replace(/\/$/, "");
+  const hasSitemapLine = siteUrlBase !== "" && settings.sitemap;
+
+  const sitemapLine = hasSitemapLine
+    ? `Sitemap: ${siteUrlBase}/sitemap.xml\n`
+    : "";
+
+  return `User-agent: *\nAllow: /\n${sitemapLine}`;
+}