docs-i18n 0.7.4 → 0.8.0

package/template/app/utils/sidebar-generator.ts

@@ -0,0 +1,185 @@
+/**
+ * Filesystem-based sidebar generation.
+ *
+ * Walks a content directory tree, sorts entries by numeric prefix,
+ * and produces a DocsConfig with sections (directories) and items (files).
+ */
+
+import { readdirSync, readFileSync, existsSync, statSync } from 'node:fs'
+import { join } from 'node:path'
+import matter from 'gray-matter'
+import type {
+  DocsConfig,
+  DocsConfigSection,
+  DocsConfigItem,
+} from '~/types'
+
+/**
+ * Convert a kebab-case name to Title Case.
+ * 'getting-started' → 'Getting Started'
+ */
+function toTitleCase(name: string): string {
+  return name
+    .split('-')
+    .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
+    .join(' ')
+}
+
+/**
+ * Strip a leading numeric prefix from a single name segment.
+ * '01-getting-started' → 'getting-started'
+ */
+function stripPrefix(name: string): string {
+  return name.replace(/^\d+-/, '')
+}
+
+/**
+ * Extract the numeric prefix for sorting. Returns Infinity if none.
+ */
+function sortOrder(name: string): number {
+  const match = name.match(/^(\d+)-/)
+  return match ? parseInt(match[1], 10) : Infinity
+}
+
+/**
+ * Try to read the frontmatter title from a markdown file.
+ */
+function readTitle(filePath: string): string | null {
+  try {
+    const raw = readFileSync(filePath, 'utf-8')
+    const { data } = matter(raw)
+    if (typeof data.title === 'string' && data.title) return data.title
+  } catch {
+    // ignore
+  }
+  return null
+}
+
+/**
+ * Generate a DocsConfig by walking a content directory.
+ *
+ * @param contentDir  Absolute path to the content directory to scan
+ *                    (e.g. `/path/to/content/latest/docs/en`)
+ * @param urlMapper   Optional function to transform relative file paths to URL slugs
+ */
+export function generateSidebarFromFilesystem(
+  contentDir: string,
+  urlMapper?: (path: string) => string,
+): DocsConfig {
+  if (!existsSync(contentDir) || !statSync(contentDir).isDirectory()) {
+    return { sections: [] }
+  }
+
+  const sections = buildSections(contentDir, contentDir, urlMapper)
+  return { sections }
+}
+
+/**
+ * Recursively build sidebar sections from a directory.
+ * Directories become sections, .md/.mdx files become items.
+ */
+function buildSections(
+  dir: string,
+  baseDir: string,
+  urlMapper?: (path: string) => string,
+): DocsConfigSection[] {
+  const sections: DocsConfigSection[] = []
+
+  let entries: ReturnType<typeof readdirSync>
+  try {
+    entries = readdirSync(dir, { withFileTypes: true })
+  } catch {
+    return sections
+  }
+
+  // Sort by numeric prefix
+  const sorted = [...entries].sort(
+    (a, b) => sortOrder(a.name) - sortOrder(b.name),
+  )
+
+  // Collect top-level files (items without a section) — only at root level
+  const topLevelItems: DocsConfigItem[] = []
+
+  for (const entry of sorted) {
+    if (entry.name.startsWith('.')) continue
+
+    if (entry.isDirectory()) {
+      const subDir = join(dir, entry.name)
+      const cleanName = stripPrefix(entry.name)
+      const label = toTitleCase(cleanName)
+
+      // Collect all file items from this directory (recursively flattened into children)
+      const children = collectItems(subDir, baseDir, urlMapper)
+
+      if (children.length > 0) {
+        sections.push({ label, children })
+      }
+    } else if (
+      entry.isFile() &&
+      (entry.name.endsWith('.md') || entry.name.endsWith('.mdx'))
+    ) {
+      const filePath = join(dir, entry.name)
+      const relativePath = filePath
+        .slice(baseDir.length + 1) // remove baseDir prefix + leading slash
+      const cleanName = stripPrefix(entry.name).replace(/\.mdx?$/, '')
+      const slug = urlMapper ? urlMapper(relativePath) : relativePath.replace(/\.mdx?$/, '')
+      const title = readTitle(filePath)
+      const label = title || toTitleCase(cleanName)
+
+      topLevelItems.push({ label, to: slug })
+    }
+  }
+
+  // If there are top-level files, add them as a section
+  if (topLevelItems.length > 0) {
+    sections.unshift({
+      label: 'Overview',
+      children: topLevelItems,
+    })
+  }
+
+  return sections
+}
+
+/**
+ * Collect all file items from a directory, recursing into subdirectories.
+ * Subdirectory files are flattened into a single list of items.
+ */
+function collectItems(
+  dir: string,
+  baseDir: string,
+  urlMapper?: (path: string) => string,
+): DocsConfigItem[] {
+  const items: DocsConfigItem[] = []
+
+  let entries: ReturnType<typeof readdirSync>
+  try {
+    entries = readdirSync(dir, { withFileTypes: true })
+  } catch {
+    return items
+  }
+
+  const sorted = [...entries].sort(
+    (a, b) => sortOrder(a.name) - sortOrder(b.name),
+  )
+
+  for (const entry of sorted) {
+    if (entry.name.startsWith('.')) continue
+
+    if (entry.isFile() && (entry.name.endsWith('.md') || entry.name.endsWith('.mdx'))) {
+      const filePath = join(dir, entry.name)
+      const relativePath = filePath.slice(baseDir.length + 1)
+      const cleanName = stripPrefix(entry.name).replace(/\.mdx?$/, '')
+      const slug = urlMapper ? urlMapper(relativePath) : relativePath.replace(/\.mdx?$/, '')
+      const title = readTitle(filePath)
+      const label = title || toTitleCase(cleanName)
+
+      items.push({ label, to: slug })
+    } else if (entry.isDirectory() && !entry.name.startsWith('.')) {
+      // Recurse into subdirectories
+      items.push(...collectItems(join(dir, entry.name), baseDir, urlMapper))
+    }
+  }
+
+  return items
+}

package/template/app/utils/url-mapper.ts

@@ -0,0 +1,22 @@
+/**
+ * Built-in URL mapping helpers for transforming file paths to URL slugs.
+ *
+ * Projects with numeric-prefixed directories (e.g. nextjs-i18n-docs) can use
+ * `stripNumericPrefixes` as their `urlMapper` in ProjectConfig.
+ */
+
+/**
+ * Strip numeric prefixes, file extensions, and trailing /index from a file path.
+ *
+ * Example:
+ *   '01-app/01-getting-started/01-installation.mdx'
+ *   → 'app/getting-started/installation'
+ */
+export function stripNumericPrefixes(filePath: string): string {
+  return filePath
+    .replace(/\.mdx?$/, '') // strip .md or .mdx extension
+    .split('/')
+    .map((segment) => segment.replace(/^\d+-/, '')) // strip leading numeric prefix per segment
+    .join('/')
+    .replace(/\/index$/, '') // strip trailing /index
+}

package/template/package.json

@@ -12,8 +12,8 @@
     "@shikijs/transformers": "^3.0.0",
     "@tailwindcss/typography": "^0.5.16",
     "@tailwindcss/vite": "^4.1.7",
-    "@tanstack/react-router": "^1.120.3",
     "@tanstack/react-query": "^5.0.0",
+    "@tanstack/react-router": "^1.120.3",
     "@tanstack/react-start": "^1.120.3",
     "drizzle-orm": "^0.38.0",
     "gray-matter": "^4.0.3",
@@ -32,6 +32,7 @@
     "rehype-slug": "^6.0.0",
     "rehype-stringify": "^10.0.1",
     "remark-gfm": "^4.0.1",
+    "remark-mdx": "^3.1.1",
     "remark-parse": "^11.0.0",
     "remark-rehype": "^11.1.2",
     "shiki": "^3.0.0",

package/admin/dist/server/assets/router-D00bP5CU.js

@@ -1,67 +0,0 @@
-import { t as Route$1 } from "./routes-C2UFxDWZ.js";
-import "react";
-import { HeadContent, Outlet, Scripts, createRootRouteWithContext, createRouter } from "@tanstack/react-router";
-import { jsx, jsxs } from "react/jsx-runtime";
-import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
-//#region app/styles.css?url
-var styles_default = "/assets/styles-DJ6QEJmN.css";
-//#endregion
-//#region app/routes/__root.tsx
-var Route = createRootRouteWithContext()({
-	head: () => ({
-		meta: [{ charSet: "utf-8" }, {
-			name: "viewport",
-			content: "width=device-width, initial-scale=1"
-		}],
-		links: [{
-			rel: "stylesheet",
-			href: styles_default
-		}]
-	}),
-	component: RootComponent,
-	notFoundComponent: () => /* @__PURE__ */ jsx("div", {
-		style: { padding: 20 },
-		children: "Page not found"
-	})
-});
-function RootComponent() {
-	const { queryClient } = Route.useRouteContext();
-	return /* @__PURE__ */ jsx(RootDocument, { children: /* @__PURE__ */ jsx(QueryClientProvider, {
-		client: queryClient,
-		children: /* @__PURE__ */ jsx(Outlet, {})
-	}) });
-}
-function RootDocument({ children }) {
-	return /* @__PURE__ */ jsxs("html", {
-		lang: "en",
-		"data-theme": "dark",
-		suppressHydrationWarning: true,
-		children: [/* @__PURE__ */ jsx("head", { children: /* @__PURE__ */ jsx(HeadContent, {}) }), /* @__PURE__ */ jsxs("body", { children: [
-			/* @__PURE__ */ jsx("script", { dangerouslySetInnerHTML: { __html: `document.documentElement.dataset.theme=localStorage.getItem('theme')||'dark'` } }),
-			children,
-			/* @__PURE__ */ jsx(Scripts, {})
-		] })]
-	});
-}
-//#endregion
-//#region app/routeTree.gen.ts
-var rootRouteChildren = { IndexRoute: Route$1.update({
-	id: "/",
-	path: "/",
-	getParentRoute: () => Route
-}) };
-var routeTree = Route._addFileChildren(rootRouteChildren)._addFileTypes();
-//#endregion
-//#region app/router.tsx
-function getRouter() {
-	return createRouter({
-		routeTree,
-		context: { queryClient: new QueryClient({ defaultOptions: { queries: {
-			refetchOnWindowFocus: false,
-			retry: 1
-		} } }) },
-		scrollRestoration: true
-	});
-}
-//#endregion
-export { getRouter };

package/admin/dist/server/assets/routes-C2UFxDWZ.js

@@ -1,24 +0,0 @@
-import { createFileRoute, lazyRouteComponent } from "@tanstack/react-router";
-//#region app/routes/index.tsx
-var $$splitComponentImporter = () => import("./routes-vEKXnl0r.js");
-/**
-* Parse version keys into project/version structure.
-* Multi-project keys look like "query/v5", single-project keys look like "v5".
-*/
-var Route = createFileRoute("/")({
-	validateSearch: (search) => ({
-		project: search.project || void 0,
-		v: search.v || void 0,
-		lang: search.lang || void 0,
-		file: search.file || void 0,
-		files: search.files || void 0,
-		view: search.view || void 0,
-		toc: search.toc || void 0,
-		nodes: search.nodes || void 0,
-		status: search.status || void 0,
-		section: search.section || void 0
-	}),
-	component: lazyRouteComponent($$splitComponentImporter, "component")
-});
-//#endregion
-export { Route as t };