@farming-labs/docs 0.0.28 → 0.0.30

package/dist/index.d.mts

@@ -999,11 +999,23 @@ interface CodeBlockCopyData {
   /** Language / syntax hint (e.g. "tsx", "bash"), if present */
   language?: string;
 }
+interface DocsI18nConfig {
+  /** Supported locale identifiers (e.g. ["en", "fr"]). */
+  locales: string[];
+  /** Default locale when `?lang=` is missing or invalid. Defaults to first locale. */
+  defaultLocale?: string;
+}
 interface DocsConfig {
   /** Entry folder for docs (e.g. "docs" → /docs) */
   entry: string;
   /** Path to the content directory. Defaults to `entry` value. */
   contentDir?: string;
+  /**
+   * Internationalization (i18n) configuration.
+   * When set, docs content is expected under `${contentDir}/{locale}` and
+   * the active locale is selected by `?lang=<locale>` in the URL.
+   */
+  i18n?: DocsI18nConfig;
   /**
    * Set to `true` when building for full static export (e.g. Cloudflare Pages).
    * When using `output: 'export'` in Next.js, the `/api/docs` route is not generated.
@@ -1326,6 +1338,21 @@ declare function createTheme(baseTheme: DocsTheme): (overrides?: Partial<DocsThe
  */
 declare function extendTheme(baseTheme: DocsTheme, extensions: Partial<DocsTheme>): DocsTheme;
 //#endregion
+//#region src/i18n.d.ts
+interface ResolvedDocsI18n {
+  locales: string[];
+  defaultLocale: string;
+}
+interface DocsPathMatch {
+  /** Slug path relative to the docs root (no leading slash). */
+  slug: string;
+  /** Entry path used for URLs (no locale segment). */
+  entryPath: string;
+}
+declare function resolveDocsI18n(config?: DocsI18nConfig | null): ResolvedDocsI18n | null;
+declare function resolveDocsLocale(searchParams: URLSearchParams, i18n?: ResolvedDocsI18n | null): string | undefined;
+declare function resolveDocsPath(pathname: string, entry: string): DocsPathMatch;
+//#endregion
 //#region src/metadata.d.ts
 /**
  * Resolve page title using metadata titleTemplate.
@@ -1350,4 +1377,4 @@ declare function buildPageOpenGraph(page: Pick<PageFrontmatter, "title" | "descr
  */
 declare function buildPageTwitter(page: Pick<PageFrontmatter, "title" | "description" | "ogImage" | "openGraph" | "twitter">, ogConfig?: OGConfig, baseUrl?: string): PageTwitter | undefined;
 //#endregion
-export { type AIConfig, type BreadcrumbConfig, type CodeBlockCopyData, type CopyMarkdownConfig, type DocsConfig, type DocsMetadata, type DocsNav, type DocsTheme, type FontStyle, type GithubConfig, type LastUpdatedConfig, type LlmsTxtConfig, type OGConfig, type OpenDocsConfig, type OpenDocsProvider, type OpenGraphImage, type OrderingItem, type PageActionsConfig, type PageFrontmatter, type PageOpenGraph, type PageTwitter, type SidebarComponentProps, type SidebarConfig, type SidebarFolderNode, type SidebarNode, type SidebarPageNode, type SidebarTree, type ThemeToggleConfig, type TypographyConfig, type UIConfig, buildPageOpenGraph, buildPageTwitter, createTheme, deepMerge, defineDocs, extendTheme, resolveOGImage, resolveTitle };
+export { type AIConfig, type BreadcrumbConfig, type CodeBlockCopyData, type CopyMarkdownConfig, type DocsConfig, type DocsI18nConfig, type DocsMetadata, type DocsNav, type DocsPathMatch, type DocsTheme, type FontStyle, type GithubConfig, type LastUpdatedConfig, type LlmsTxtConfig, type OGConfig, type OpenDocsConfig, type OpenDocsProvider, type OpenGraphImage, type OrderingItem, type PageActionsConfig, type PageFrontmatter, type PageOpenGraph, type PageTwitter, type ResolvedDocsI18n, type SidebarComponentProps, type SidebarConfig, type SidebarFolderNode, type SidebarNode, type SidebarPageNode, type SidebarTree, type ThemeToggleConfig, type TypographyConfig, type UIConfig, buildPageOpenGraph, buildPageTwitter, createTheme, deepMerge, defineDocs, extendTheme, resolveDocsI18n, resolveDocsLocale, resolveDocsPath, resolveOGImage, resolveTitle };

package/dist/index.mjs

@@ -6,6 +6,7 @@ function defineDocs(config) {
 	return {
 		entry: config.entry ?? "docs",
 		contentDir: config.contentDir,
+		i18n: config.i18n,
 		theme: config.theme,
 		nav: config.nav,
 		github: config.github,
@@ -99,6 +100,45 @@ function extendTheme(baseTheme, extensions) {
 	return deepMerge(baseTheme, extensions);
 }
 
+//#endregion
+//#region src/i18n.ts
+function normalizeSegment(value) {
+	return value.replace(/^\/+|\/+$/g, "");
+}
+function splitSegments(value) {
+	const cleaned = normalizeSegment(value);
+	return cleaned ? cleaned.split("/").filter(Boolean) : [];
+}
+function resolveDocsI18n(config) {
+	if (!config || !Array.isArray(config.locales)) return null;
+	const locales = Array.from(new Set(config.locales.map((l) => l.trim()).filter(Boolean)));
+	if (locales.length === 0) return null;
+	return {
+		locales,
+		defaultLocale: config.defaultLocale && locales.includes(config.defaultLocale) ? config.defaultLocale : locales[0]
+	};
+}
+function resolveDocsLocale(searchParams, i18n) {
+	if (!i18n) return void 0;
+	const raw = searchParams.get("lang") ?? searchParams.get("locale");
+	if (!raw) return void 0;
+	if (i18n.locales.includes(raw)) return raw;
+	return i18n.defaultLocale;
+}
+function resolveDocsPath(pathname, entry) {
+	const entryBase = normalizeSegment(entry || "docs") || "docs";
+	const entryParts = splitSegments(entryBase);
+	const pathParts = splitSegments(pathname);
+	let rest = pathParts;
+	if (entryParts.length > 0) {
+		if (pathParts.slice(0, entryParts.length).join("/") === entryParts.join("/")) rest = pathParts.slice(entryParts.length);
+	}
+	return {
+		slug: rest.join("/"),
+		entryPath: entryBase
+	};
+}
+
 //#endregion
 //#region src/metadata.ts
 /**
@@ -180,4 +220,4 @@ function buildPageTwitter(page, ogConfig, baseUrl) {
 }
 
 //#endregion
-export { buildPageOpenGraph, buildPageTwitter, createTheme, deepMerge, defineDocs, extendTheme, resolveOGImage, resolveTitle };
+export { buildPageOpenGraph, buildPageTwitter, createTheme, deepMerge, defineDocs, extendTheme, resolveDocsI18n, resolveDocsLocale, resolveDocsPath, resolveOGImage, resolveTitle };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farming-labs/docs",
-  "version": "0.0.28",
+  "version": "0.0.30",
   "description": "Modern, flexible MDX-based docs framework — core types, config, and CLI",
   "keywords": [
     "docs",