@blackwork/docs 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-PRESENT chengpeiquan (https://github.com/chengpeiquan)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,330 @@
+# @blackwork/docs
+
+`@blackwork/docs` is a Next.js-first documentation framework for the Blackwork ecosystem.
+
+It sits one layer above `blackwork` and `@blackwork/machine`:
+
+- `blackwork` provides the UI base and Tailwind theme.
+- `@blackwork/machine` provides Markdown and MDX compilation.
+- `@blackwork/docs` provides the docs-site runtime: content discovery, locale-aware routing, metadata, navigation, theme shells, and the public Next.js entry surface.
+
+## Install
+
+```bash
+pnpm add @blackwork/docs blackwork next react react-dom
+```
+
+## Recommended Project Shape
+
+```text
+my-docs/
+  content.config.ts
+  contents/
+    en/
+      index.mdx
+      guide/getting-started.mdx
+    zh/
+      index.mdx
+  docs.config.ts
+  src/
+    app/
+      layout.tsx
+      [[...slug]]/
+        page.tsx
+    mdx/
+      components/
+        callout.tsx
+```
+
+The required app-facing files are intentionally thin:
+
+- `next.config.ts` wraps the app with `withBlackworkDocs()`.
+- `content.config.ts` defines pure content settings such as content root,
+  locales, and section behavior.
+- `docs.config.ts` defines site and MDX component configuration.
+- `src/app/layout.tsx` mounts `DocsRootLayout`.
+- `src/app/[[...slug]]/page.tsx` delegates page rendering, metadata, and static params to `@blackwork/docs`.
+- `contents/**` stores the actual docs content.
+
+## Minimal Config
+
+`content.config.ts`
+
+```ts
+export const docsContentConfig = {
+  root: 'contents',
+  defaultLocale: 'en',
+  enableDefaultLocaleRedirect: true,
+  locales: {
+    en: {
+      code: 'en',
+      label: 'English',
+    },
+    zh: {
+      code: 'zh',
+      label: '简体中文',
+    },
+  },
+}
+```
+
+Optional section behavior can also stay in `content.config.ts` when different
+top-level content directories need different layouts:
+
+```ts
+export const docsContentConfig = {
+  root: 'contents',
+  defaultLocale: 'en',
+  sections: {
+    guide: {
+      layout: 'docs',
+      sidebar: 'auto',
+    },
+    reference: {
+      layout: 'docs',
+      sidebar: 'auto',
+    },
+    article: {
+      layout: 'content',
+    },
+  },
+}
+```
+
+The first directory under `contents/<locale>/` is treated as the section key.
+`layout: 'docs'` keeps the left docs sidebar, while `layout: 'content'` renders
+the article without that sidebar. Home pages still use the dedicated landing
+shell.
+
+## Manual Sidebars
+
+Docs sections can replace the generated sidebar with a manual tree in
+`content.config.ts`:
+
+```ts
+export const docsContentConfig = {
+  root: 'contents',
+  defaultLocale: 'en',
+  sections: {
+    guide: {
+      layout: 'docs',
+      sidebar: [
+        {
+          type: 'group',
+          label: {
+            en: 'Foundations',
+            zh: '基础',
+          },
+          items: [
+            {
+              type: 'item',
+              href: '/guide',
+            },
+            {
+              type: 'item',
+              href: '/guide/getting-started',
+              label: {
+                en: 'Quickstart',
+                zh: '快速开始',
+              },
+            },
+          ],
+        },
+        {
+          type: 'group',
+          label: {
+            en: 'Resources',
+            zh: '资源',
+          },
+          items: [
+            {
+              type: 'item',
+              href: 'https://example.com/changelog',
+              label: {
+                en: 'Changelog',
+                zh: '更新日志',
+              },
+            },
+          ],
+        },
+      ],
+    },
+  },
+}
+```
+
+Rules for the first manual-sidebar slice:
+
+- `sidebar` accepts `'auto'`, `false`, or an array of `group` / `item` nodes.
+- Manual sidebars fully replace automatic sidebar generation for that section.
+- Internal `href` values should use full docs paths such as
+  `'/guide/getting-started'`.
+- Internal item `label` is optional. When omitted, the current locale falls
+  back to the linked page title.
+- Localized labels fall back to `defaultLocale` when the current locale key is
+  missing.
+- External items stay visible in the sidebar, but the pager skips them.
+- Pager order follows the manual tree depth-first across groups.
+
+Manual internal links validate eagerly against the docs source for the current
+locale. A missing page throws an actionable error like:
+
+```txt
+[blackwork-docs] Invalid sidebar item in section "guide": href "/guide/design" does not match any document entry in locale "en". Add the page or remove the sidebar item.
+```
+
+`docs.config.ts`
+
+```ts
+import { defineDocsConfig } from '@blackwork/docs'
+import { Callout } from './src/mdx/components/callout'
+
+export const docsConfig = defineDocsConfig({
+  site: {
+    title: 'My Docs',
+    description: 'Project documentation powered by Blackwork Docs.',
+  },
+  mdx: {
+    components: {
+      Callout,
+    },
+  },
+})
+```
+
+## Next.js Entry Files
+
+`next.config.ts`
+
+```ts
+import type { NextConfig } from 'next'
+import { withBlackworkDocs } from '@blackwork/docs/next'
+
+const nextConfig: NextConfig = {
+  images: {
+    unoptimized: true,
+  },
+  transpilePackages: ['blackwork'],
+}
+
+export default withBlackworkDocs()(nextConfig)
+```
+
+The wrapper generates a docs manifest under `.blackwork/docs` and keeps it in
+sync during development so Markdown and MDX changes participate in the Next
+module graph instead of relying on client polling.
+
+`withBlackworkDocs()` auto-discovers the root-level `content.config.ts` file.
+Keep that file pure data only. Runtime-only configuration such as MDX component
+overrides should stay in `docs.config.ts`.
+
+`src/app/layout.tsx`
+
+```tsx
+import { DocsRootLayout } from '@blackwork/docs'
+import { docsConfig } from '../../docs.config'
+import 'blackwork/ui-globals.css'
+import './globals.css'
+
+export default function RootLayout({
+  children,
+  params,
+}: Readonly<{
+  children: React.ReactNode
+  params: Promise<{ slug?: string[] }>
+}>) {
+  return (
+    <DocsRootLayout config={docsConfig} params={params}>
+      {children}
+    </DocsRootLayout>
+  )
+}
+```
+
+`src/app/[[...slug]]/page.tsx`
+
+```tsx
+import {
+  DocsPage,
+  generateMetadata as generateDocsMetadata,
+  generateStaticParams as generateDocsStaticParams,
+} from '@blackwork/docs'
+import { notFound, redirect } from 'next/navigation'
+import { docsConfig } from '../../../docs.config'
+
+const rootDir = '.'
+
+export const dynamicParams = false
+
+export async function generateStaticParams() {
+  return generateDocsStaticParams({
+    config: docsConfig,
+    rootDir,
+  })
+}
+
+export async function generateMetadata({
+  params,
+}: {
+  params: Promise<{ slug?: string[] }>
+}) {
+  return generateDocsMetadata({
+    config: docsConfig,
+    params,
+    rootDir,
+  })
+}
+
+export default function DocsRoutePage({
+  params,
+}: {
+  params: Promise<{ slug?: string[] }>
+}) {
+  return DocsPage({
+    config: docsConfig,
+    onNotFound: () => notFound(),
+    onRedirect: (href) => redirect(href),
+    params,
+    rootDir,
+  })
+}
+```
+
+## Tailwind Setup
+
+If your app uses Tailwind CSS, include both `blackwork` and `@blackwork/docs` build output in the content scan:
+
+```ts
+import typography from '@tailwindcss/typography'
+import { theme } from 'blackwork/tailwind-config'
+import animate from 'tailwindcss-animate'
+import type { Config } from 'tailwindcss'
+
+export default {
+  darkMode: 'selector',
+  content: [
+    './src/**/*.{js,mjs,cjs,ts,jsx,tsx,mdx}',
+    './contents/**/*.{md,mdx}',
+    './node_modules/blackwork/dist/**/*.{js,mjs,cjs}',
+    './node_modules/@blackwork/docs/dist/**/*.{js,mjs,cjs}',
+  ],
+  theme,
+  plugins: [typography, animate],
+} satisfies Config
+```
+
+## Difference From `@blackwork/machine`
+
+Use `@blackwork/machine` when you only need Markdown or MDX compilation:
+
+- Markdown / MDX compilation
+- component merging
+- lightweight Next adapter support
+
+Use `@blackwork/docs` when you need a full docs-site runtime:
+
+- content directory indexing
+- locale-aware route resolution
+- static params and metadata generation
+- sidebar, pager, locale links, and default shells
+- thin Next.js integration surface from the root package entry

package/dist/_virtual/_rolldown/runtime.cjs

@@ -0,0 +1,9 @@
+/**
+ * name: @blackwork/docs
+ * version: v0.1.0
+ * description: Next-first documentation framework for Blackwork projects.
+ * author: chengpeiquan <chengpeiquan@chengpeiquan.com>
+ * homepage: https://chengpeiquan.com
+ * license: MIT
+ */
+var e=Object.create,t=Object.defineProperty,n=Object.getOwnPropertyDescriptor,r=Object.getOwnPropertyNames,i=Object.getPrototypeOf,a=Object.prototype.hasOwnProperty,o=(e,i,o,s)=>{if(i&&typeof i==`object`||typeof i==`function`)for(var c=r(i),l=0,u=c.length,d;l<u;l++)d=c[l],!a.call(e,d)&&d!==o&&t(e,d,{get:(e=>i[e]).bind(null,d),enumerable:!(s=n(i,d))||s.enumerable});return e},s=(n,r,a)=>(a=n==null?{}:e(i(n)),o(r||!n||!n.__esModule?t(a,`default`,{value:n,enumerable:!0}):a,n));exports.__toESM=s;

package/dist/config/defaults.cjs

@@ -0,0 +1,9 @@
+/**
+ * name: @blackwork/docs
+ * version: v0.1.0
+ * description: Next-first documentation framework for Blackwork projects.
+ * author: chengpeiquan <chengpeiquan@chengpeiquan.com>
+ * homepage: https://chengpeiquan.com
+ * license: MIT
+ */
+const e={site:{},content:{root:`contents`,enableDefaultLocaleRedirect:!0},theme:{},docs:{},home:{},mdx:{},slots:{}};exports.defaultDocsConfig=e;

package/dist/config/defaults.mjs

@@ -0,0 +1,9 @@
+/**
+ * name: @blackwork/docs
+ * version: v0.1.0
+ * description: Next-first documentation framework for Blackwork projects.
+ * author: chengpeiquan <chengpeiquan@chengpeiquan.com>
+ * homepage: https://chengpeiquan.com
+ * license: MIT
+ */
+const e={site:{},content:{root:`contents`,enableDefaultLocaleRedirect:!0},theme:{},docs:{},home:{},mdx:{},slots:{}};export{e as defaultDocsConfig};

package/dist/config/define-config.cjs

@@ -0,0 +1,9 @@
+/**
+ * name: @blackwork/docs
+ * version: v0.1.0
+ * description: Next-first documentation framework for Blackwork projects.
+ * author: chengpeiquan <chengpeiquan@chengpeiquan.com>
+ * homepage: https://chengpeiquan.com
+ * license: MIT
+ */
+const e=require(`./defaults.cjs`),t=(e={})=>{let t=e.layout??`docs`;return{layout:t,sidebar:e.sidebar??(t===`content`?!1:`auto`)}},n=e=>{if(e)return Object.fromEntries(Object.entries(e).map(([e,n])=>[e,t(n)]))};function r(t={}){return{root:t.root??e.defaultDocsConfig.content.root,enableDefaultLocaleRedirect:t.enableDefaultLocaleRedirect??e.defaultDocsConfig.content.enableDefaultLocaleRedirect,...t.defaultLocale===void 0?{}:{defaultLocale:t.defaultLocale},...t.locales===void 0?{}:{locales:t.locales},...t.sections===void 0?{}:{sections:n(t.sections)}}}function i(t={}){return{site:{...e.defaultDocsConfig.site,...t.site},content:r(t.content),theme:{...e.defaultDocsConfig.theme,...t.theme},docs:{...e.defaultDocsConfig.docs,...t.docs},home:{...e.defaultDocsConfig.home,...t.home},mdx:{...e.defaultDocsConfig.mdx,...t.mdx},slots:{...e.defaultDocsConfig.slots,...t.slots}}}exports.defineConfig=i;

package/dist/config/define-config.d.mts

@@ -0,0 +1,7 @@
+
+import { DocsConfig, NormalizedDocsConfig } from "./types.mjs";
+
+//#region src/config/define-config.d.ts
+declare function defineConfig(config?: DocsConfig): NormalizedDocsConfig;
+//#endregion
+export { defineConfig };

package/dist/config/define-config.d.ts

@@ -0,0 +1,7 @@
+
+import { DocsConfig, NormalizedDocsConfig } from "./types.js";
+
+//#region src/config/define-config.d.ts
+declare function defineConfig(config?: DocsConfig): NormalizedDocsConfig;
+//#endregion
+export { defineConfig };

package/dist/config/define-config.mjs

@@ -0,0 +1,9 @@
+/**
+ * name: @blackwork/docs
+ * version: v0.1.0
+ * description: Next-first documentation framework for Blackwork projects.
+ * author: chengpeiquan <chengpeiquan@chengpeiquan.com>
+ * homepage: https://chengpeiquan.com
+ * license: MIT
+ */
+import{defaultDocsConfig as e}from"./defaults.mjs";const t=(e={})=>{let t=e.layout??`docs`;return{layout:t,sidebar:e.sidebar??(t===`content`?!1:`auto`)}},n=e=>{if(e)return Object.fromEntries(Object.entries(e).map(([e,n])=>[e,t(n)]))};function r(t={}){return{root:t.root??e.content.root,enableDefaultLocaleRedirect:t.enableDefaultLocaleRedirect??e.content.enableDefaultLocaleRedirect,...t.defaultLocale===void 0?{}:{defaultLocale:t.defaultLocale},...t.locales===void 0?{}:{locales:t.locales},...t.sections===void 0?{}:{sections:n(t.sections)}}}function i(t={}){return{site:{...e.site,...t.site},content:r(t.content),theme:{...e.theme,...t.theme},docs:{...e.docs,...t.docs},home:{...e.home,...t.home},mdx:{...e.mdx,...t.mdx},slots:{...e.slots,...t.slots}}}export{i as defineConfig};

package/dist/config/define-docs-config.cjs

@@ -0,0 +1,9 @@
+/**
+ * name: @blackwork/docs
+ * version: v0.1.0
+ * description: Next-first documentation framework for Blackwork projects.
+ * author: chengpeiquan <chengpeiquan@chengpeiquan.com>
+ * homepage: https://chengpeiquan.com
+ * license: MIT
+ */
+const e=require(`./define-config.cjs`),t=require(`./load-content-config.cjs`),n=(e,t)=>{if(!e&&!t)return;let n=new Set([...Object.keys(e??{}),...Object.keys(t??{})]);return Object.fromEntries([...n].map(n=>[n,{...e?.[n]??{},...t?.[n]??{}}]))};function r(r={},i={}){let a=t.loadDocsContentConfig(i),o=n(a?.sections,r.content?.sections),s=a||r.content?{...a??{},...r.content??{},...o?{sections:o}:{}}:void 0;return e.defineConfig({...r,...s?{content:s}:{}})}exports.defineDocsConfig=r;

package/dist/config/define-docs-config.d.mts

@@ -0,0 +1,9 @@
+
+import { DocsConfig, NormalizedDocsConfig } from "./types.mjs";
+import { LoadDocsContentConfigOptions } from "./load-content-config.mjs";
+
+//#region src/config/define-docs-config.d.ts
+interface DefineDocsConfigOptions extends LoadDocsContentConfigOptions {}
+declare function defineDocsConfig(config?: DocsConfig | NormalizedDocsConfig, options?: DefineDocsConfigOptions): NormalizedDocsConfig;
+//#endregion
+export { DefineDocsConfigOptions, defineDocsConfig };

package/dist/config/define-docs-config.d.ts

@@ -0,0 +1,9 @@
+
+import { DocsConfig, NormalizedDocsConfig } from "./types.js";
+import { LoadDocsContentConfigOptions } from "./load-content-config.js";
+
+//#region src/config/define-docs-config.d.ts
+interface DefineDocsConfigOptions extends LoadDocsContentConfigOptions {}
+declare function defineDocsConfig(config?: DocsConfig | NormalizedDocsConfig, options?: DefineDocsConfigOptions): NormalizedDocsConfig;
+//#endregion
+export { DefineDocsConfigOptions, defineDocsConfig };

package/dist/config/define-docs-config.mjs

@@ -0,0 +1,9 @@
+/**
+ * name: @blackwork/docs
+ * version: v0.1.0
+ * description: Next-first documentation framework for Blackwork projects.
+ * author: chengpeiquan <chengpeiquan@chengpeiquan.com>
+ * homepage: https://chengpeiquan.com
+ * license: MIT
+ */
+import{defineConfig as e}from"./define-config.mjs";import{loadDocsContentConfig as t}from"./load-content-config.mjs";const n=(e,t)=>{if(!e&&!t)return;let n=new Set([...Object.keys(e??{}),...Object.keys(t??{})]);return Object.fromEntries([...n].map(n=>[n,{...e?.[n]??{},...t?.[n]??{}}]))};function r(r={},i={}){let a=t(i),o=n(a?.sections,r.content?.sections),s=a||r.content?{...a??{},...r.content??{},...o?{sections:o}:{}}:void 0;return e({...r,...s?{content:s}:{}})}export{r as defineDocsConfig};

package/dist/config/load-content-config.cjs

@@ -0,0 +1,9 @@
+/**
+ * name: @blackwork/docs
+ * version: v0.1.0
+ * description: Next-first documentation framework for Blackwork projects.
+ * author: chengpeiquan <chengpeiquan@chengpeiquan.com>
+ * homepage: https://chengpeiquan.com
+ * license: MIT
+ */
+const e=require(`../_virtual/_rolldown/runtime.cjs`);let t=require(`node:fs`),n=require(`node:path`),r=require(`jiti`);r=e.__toESM(r,1);const i=`content.config.ts`,a=e=>typeof e==`object`&&!!e&&!Array.isArray(e),o=({rootDir:e=process.cwd(),contentConfigPath:r=i}={})=>{let a=(0,n.resolve)(e,r);return(0,t.existsSync)(a)?a:void 0},s=({rootDir:e=process.cwd(),contentConfigPath:t=i}={})=>{let n=o({rootDir:e,contentConfigPath:t});if(!n)return;let s=(0,r.default)(require(`url`).pathToFileURL(__filename).href)(n),c=s?.docsContentConfig??s?.default;if(!a(c))throw TypeError(`[blackwork-docs] ${n} must export a docs content config object via "docsContentConfig" or default export.`);return c};exports.loadDocsContentConfig=s,exports.resolveDocsContentConfigPath=o;

package/dist/config/load-content-config.d.mts

@@ -0,0 +1,8 @@
+
+//#region src/config/load-content-config.d.ts
+interface LoadDocsContentConfigOptions {
+  rootDir?: string;
+  contentConfigPath?: string;
+}
+//#endregion
+export { LoadDocsContentConfigOptions };

package/dist/config/load-content-config.d.ts

@@ -0,0 +1,8 @@
+
+//#region src/config/load-content-config.d.ts
+interface LoadDocsContentConfigOptions {
+  rootDir?: string;
+  contentConfigPath?: string;
+}
+//#endregion
+export { LoadDocsContentConfigOptions };

package/dist/config/load-content-config.mjs

@@ -0,0 +1,9 @@
+/**
+ * name: @blackwork/docs
+ * version: v0.1.0
+ * description: Next-first documentation framework for Blackwork projects.
+ * author: chengpeiquan <chengpeiquan@chengpeiquan.com>
+ * homepage: https://chengpeiquan.com
+ * license: MIT
+ */
+import{existsSync as e}from"node:fs";import{resolve as t}from"node:path";import n from"jiti";const r=`content.config.ts`,i=e=>typeof e==`object`&&!!e&&!Array.isArray(e),a=({rootDir:n=process.cwd(),contentConfigPath:i=r}={})=>{let a=t(n,i);return e(a)?a:void 0},o=({rootDir:e=process.cwd(),contentConfigPath:t=r}={})=>{let o=a({rootDir:e,contentConfigPath:t});if(!o)return;let s=n(import.meta.url)(o),c=s?.docsContentConfig??s?.default;if(!i(c))throw TypeError(`[blackwork-docs] ${o} must export a docs content config object via "docsContentConfig" or default export.`);return c};export{o as loadDocsContentConfig,a as resolveDocsContentConfigPath};

package/dist/config/types.d.mts

@@ -0,0 +1,78 @@
+
+import { DocsHomeConfig as DocsHomeConfig$1, DocsSlotsConfig as DocsSlotsConfig$1 } from "../theme/types.mjs";
+import { ComponentMap } from "@blackwork/machine";
+
+//#region src/config/types.d.ts
+interface DocsLocaleDefinition {
+  code: string;
+  label?: string;
+  lang?: string;
+}
+interface DocsSiteConfig {
+  title?: string;
+  description?: string;
+  url?: string;
+}
+type DocsSectionLayout = 'docs' | 'content';
+type DocsSidebarLabel = string | Record<string, string>;
+interface DocsSidebarItemConfig {
+  type: 'item';
+  href: string;
+  label?: DocsSidebarLabel;
+}
+interface DocsSidebarGroupConfig {
+  type: 'group';
+  label: DocsSidebarLabel;
+  items: DocsSidebarItemConfig[];
+}
+type DocsSidebarConfigNode = DocsSidebarGroupConfig | DocsSidebarItemConfig;
+type DocsSidebarMode = 'auto' | false | DocsSidebarConfigNode[];
+interface DocsContentSectionConfig {
+  layout?: DocsSectionLayout;
+  sidebar?: DocsSidebarMode;
+}
+interface DocsContentConfig {
+  root?: string;
+  defaultLocale?: string;
+  enableDefaultLocaleRedirect?: boolean;
+  locales?: Record<string, DocsLocaleDefinition>;
+  sections?: Record<string, DocsContentSectionConfig>;
+}
+type DocsThemeConfig = Record<string, unknown>;
+type DocsSectionConfig = Record<string, unknown>;
+type DocsHomeConfig = DocsHomeConfig$1;
+interface DocsMdxConfig {
+  components?: ComponentMap;
+}
+type DocsSlotsConfig = DocsSlotsConfig$1;
+interface DocsConfig {
+  site?: DocsSiteConfig;
+  content?: DocsContentConfig;
+  theme?: DocsThemeConfig;
+  docs?: DocsSectionConfig;
+  home?: DocsHomeConfig;
+  mdx?: DocsMdxConfig;
+  slots?: DocsSlotsConfig;
+}
+interface NormalizedDocsContentConfig {
+  root: string;
+  defaultLocale?: string;
+  enableDefaultLocaleRedirect: boolean;
+  locales?: Record<string, DocsLocaleDefinition>;
+  sections?: Record<string, NormalizedDocsContentSectionConfig>;
+}
+interface NormalizedDocsContentSectionConfig {
+  layout: DocsSectionLayout;
+  sidebar: DocsSidebarMode;
+}
+interface NormalizedDocsConfig {
+  site: DocsSiteConfig;
+  content: NormalizedDocsContentConfig;
+  theme: DocsThemeConfig;
+  docs: DocsSectionConfig;
+  home: DocsHomeConfig;
+  mdx: DocsMdxConfig;
+  slots: DocsSlotsConfig;
+}
+//#endregion
+export { DocsConfig, DocsContentConfig, DocsContentSectionConfig, DocsHomeConfig, DocsLocaleDefinition, DocsMdxConfig, DocsSectionConfig, DocsSectionLayout, DocsSidebarConfigNode, DocsSidebarGroupConfig, DocsSidebarItemConfig, DocsSidebarLabel, DocsSidebarMode, DocsSiteConfig, DocsSlotsConfig, DocsThemeConfig, NormalizedDocsConfig, NormalizedDocsContentConfig, NormalizedDocsContentSectionConfig };

package/dist/config/types.d.ts

@@ -0,0 +1,78 @@
+
+import { DocsHomeConfig as DocsHomeConfig$1, DocsSlotsConfig as DocsSlotsConfig$1 } from "../theme/types.js";
+import { ComponentMap } from "@blackwork/machine";
+
+//#region src/config/types.d.ts
+interface DocsLocaleDefinition {
+  code: string;
+  label?: string;
+  lang?: string;
+}
+interface DocsSiteConfig {
+  title?: string;
+  description?: string;
+  url?: string;
+}
+type DocsSectionLayout = 'docs' | 'content';
+type DocsSidebarLabel = string | Record<string, string>;
+interface DocsSidebarItemConfig {
+  type: 'item';
+  href: string;
+  label?: DocsSidebarLabel;
+}
+interface DocsSidebarGroupConfig {
+  type: 'group';
+  label: DocsSidebarLabel;
+  items: DocsSidebarItemConfig[];
+}
+type DocsSidebarConfigNode = DocsSidebarGroupConfig | DocsSidebarItemConfig;
+type DocsSidebarMode = 'auto' | false | DocsSidebarConfigNode[];
+interface DocsContentSectionConfig {
+  layout?: DocsSectionLayout;
+  sidebar?: DocsSidebarMode;
+}
+interface DocsContentConfig {
+  root?: string;
+  defaultLocale?: string;
+  enableDefaultLocaleRedirect?: boolean;
+  locales?: Record<string, DocsLocaleDefinition>;
+  sections?: Record<string, DocsContentSectionConfig>;
+}
+type DocsThemeConfig = Record<string, unknown>;
+type DocsSectionConfig = Record<string, unknown>;
+type DocsHomeConfig = DocsHomeConfig$1;
+interface DocsMdxConfig {
+  components?: ComponentMap;
+}
+type DocsSlotsConfig = DocsSlotsConfig$1;
+interface DocsConfig {
+  site?: DocsSiteConfig;
+  content?: DocsContentConfig;
+  theme?: DocsThemeConfig;
+  docs?: DocsSectionConfig;
+  home?: DocsHomeConfig;
+  mdx?: DocsMdxConfig;
+  slots?: DocsSlotsConfig;
+}
+interface NormalizedDocsContentConfig {
+  root: string;
+  defaultLocale?: string;
+  enableDefaultLocaleRedirect: boolean;
+  locales?: Record<string, DocsLocaleDefinition>;
+  sections?: Record<string, NormalizedDocsContentSectionConfig>;
+}
+interface NormalizedDocsContentSectionConfig {
+  layout: DocsSectionLayout;
+  sidebar: DocsSidebarMode;
+}
+interface NormalizedDocsConfig {
+  site: DocsSiteConfig;
+  content: NormalizedDocsContentConfig;
+  theme: DocsThemeConfig;
+  docs: DocsSectionConfig;
+  home: DocsHomeConfig;
+  mdx: DocsMdxConfig;
+  slots: DocsSlotsConfig;
+}
+//#endregion
+export { DocsConfig, DocsContentConfig, DocsContentSectionConfig, DocsHomeConfig, DocsLocaleDefinition, DocsMdxConfig, DocsSectionConfig, DocsSectionLayout, DocsSidebarConfigNode, DocsSidebarGroupConfig, DocsSidebarItemConfig, DocsSidebarLabel, DocsSidebarMode, DocsSiteConfig, DocsSlotsConfig, DocsThemeConfig, NormalizedDocsConfig, NormalizedDocsContentConfig, NormalizedDocsContentSectionConfig };

package/dist/index.cjs

@@ -0,0 +1,9 @@
+/**
+ * name: @blackwork/docs
+ * version: v0.1.0
+ * description: Next-first documentation framework for Blackwork projects.
+ * author: chengpeiquan <chengpeiquan@chengpeiquan.com>
+ * homepage: https://chengpeiquan.com
+ * license: MIT
+ */
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require(`./config/define-config.cjs`),t=require(`./config/define-docs-config.cjs`),n=require(`./navigation/build-locale-links.cjs`),r=require(`./metadata/create-doc-metadata.cjs`),i=require(`./navigation/build-pager.cjs`),a=require(`./navigation/build-sidebar.cjs`),o=require(`./next/root-layout.cjs`),s=require(`./routing/build-static-params.cjs`),c=require(`./routing/resolve-docs-route.cjs`),l=require(`./source/create-docs-source.cjs`),u=async(e={})=>(await Promise.resolve().then(()=>require(`./next/metadata.cjs`))).generateMetadata(e),d=async(e={})=>(await Promise.resolve().then(()=>require(`./next/page.cjs`))).generateStaticParams(e),f=async e=>(await Promise.resolve().then(()=>require(`./next/page.cjs`))).DocsPage(e);exports.DocsPage=f,exports.DocsRootLayout=o.DocsRootLayout,exports.buildDocsStaticParams=s.buildDocsStaticParams,exports.buildLocaleLinks=n.buildLocaleLinks,exports.buildPager=i.buildPager,exports.buildSidebar=a.buildSidebar,exports.createDocMetadata=r.createDocMetadata,exports.createDocsSource=l.createDocsSource,exports.defineConfig=e.defineConfig,exports.defineDocsConfig=t.defineDocsConfig,exports.dynamicParams=!1,exports.generateMetadata=u,exports.generateStaticParams=d,exports.resolveDocsRoute=c.resolveDocsRoute;