@blackwork/docs 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/_virtual/_rolldown/runtime.cjs +1 -1
- package/dist/config/defaults.cjs +1 -1
- package/dist/config/defaults.mjs +1 -1
- package/dist/config/define-config.cjs +1 -1
- package/dist/config/define-config.mjs +1 -1
- package/dist/config/define-docs-config.cjs +1 -1
- package/dist/config/define-docs-config.mjs +1 -1
- package/dist/config/load-content-config.cjs +1 -1
- package/dist/config/load-content-config.mjs +1 -1
- package/dist/export/process-exported-docs.cjs +9 -0
- package/dist/export/process-exported-docs.d.mts +16 -0
- package/dist/export/process-exported-docs.d.ts +16 -0
- package/dist/export/process-exported-docs.mjs +9 -0
- package/dist/index.cjs +2 -2
- package/dist/index.d.mts +2 -1
- package/dist/index.d.ts +2 -1
- package/dist/index.mjs +2 -2
- package/dist/mdx/default-docs-components.cjs +1 -1
- package/dist/mdx/default-docs-components.mjs +1 -1
- package/dist/mdx/merge-docs-components.cjs +1 -1
- package/dist/mdx/merge-docs-components.mjs +1 -1
- package/dist/metadata/create-doc-metadata.cjs +1 -1
- package/dist/metadata/create-doc-metadata.mjs +1 -1
- package/dist/navigation/build-locale-links.cjs +1 -1
- package/dist/navigation/build-locale-links.mjs +1 -1
- package/dist/navigation/build-pager.cjs +1 -1
- package/dist/navigation/build-pager.mjs +1 -1
- package/dist/navigation/build-sidebar.cjs +1 -1
- package/dist/navigation/build-sidebar.mjs +1 -1
- package/dist/navigation/resolve-sidebar.cjs +1 -1
- package/dist/navigation/resolve-sidebar.mjs +1 -1
- package/dist/next/context.cjs +1 -1
- package/dist/next/context.mjs +1 -1
- package/dist/next/document-lang-sync.cjs +9 -0
- package/dist/next/document-lang-sync.mjs +9 -0
- package/dist/next/load-doc-content.cjs +1 -1
- package/dist/next/load-doc-content.mjs +1 -1
- package/dist/next/load-generated-manifest.cjs +1 -1
- package/dist/next/load-generated-manifest.mjs +1 -1
- package/dist/next/metadata.cjs +1 -1
- package/dist/next/metadata.mjs +1 -1
- package/dist/next/page.cjs +1 -1
- package/dist/next/page.mjs +1 -1
- package/dist/next/render-route.cjs +1 -1
- package/dist/next/render-route.mjs +1 -1
- package/dist/next/resolve-document-lang.cjs +1 -1
- package/dist/next/resolve-document-lang.mjs +1 -1
- package/dist/next/root-layout.cjs +2 -2
- package/dist/next/root-layout.mjs +2 -2
- package/dist/next-plugin/generate.cjs +1 -1
- package/dist/next-plugin/generate.mjs +1 -1
- package/dist/next.cjs +1 -1
- package/dist/next.mjs +1 -1
- package/dist/routing/build-static-params.cjs +1 -1
- package/dist/routing/build-static-params.mjs +1 -1
- package/dist/routing/resolve-docs-route.cjs +1 -1
- package/dist/routing/resolve-docs-route.mjs +1 -1
- package/dist/runtime.cjs +1 -1
- package/dist/runtime.mjs +1 -1
- package/dist/source/build-docs-source.cjs +1 -1
- package/dist/source/build-docs-source.mjs +1 -1
- package/dist/source/collect-docs-manifest.cjs +1 -1
- package/dist/source/collect-docs-manifest.mjs +1 -1
- package/dist/source/create-docs-source-from-manifest.cjs +1 -1
- package/dist/source/create-docs-source-from-manifest.mjs +1 -1
- package/dist/source/create-docs-source.cjs +1 -1
- package/dist/source/create-docs-source.mjs +1 -1
- package/dist/theme/components/content-shell.cjs +2 -2
- package/dist/theme/components/content-shell.mjs +2 -2
- package/dist/theme/components/docs-rail-scroll-state.cjs +1 -1
- package/dist/theme/components/docs-rail-scroll-state.mjs +1 -1
- package/dist/theme/components/docs-rail-scroll.cjs +1 -1
- package/dist/theme/components/docs-rail-scroll.mjs +1 -1
- package/dist/theme/components/docs-scroll-reset.cjs +1 -1
- package/dist/theme/components/docs-scroll-reset.mjs +1 -1
- package/dist/theme/components/docs-scroll-to-top.cjs +9 -0
- package/dist/theme/components/docs-scroll-to-top.mjs +9 -0
- package/dist/theme/components/docs-shell.cjs +2 -2
- package/dist/theme/components/docs-shell.mjs +2 -2
- package/dist/theme/components/docs-toc-geometry.cjs +1 -1
- package/dist/theme/components/docs-toc-geometry.mjs +1 -1
- package/dist/theme/components/docs-toc.cjs +2 -2
- package/dist/theme/components/docs-toc.mjs +2 -2
- package/dist/theme/components/floating-actions.cjs +9 -0
- package/dist/theme/components/floating-actions.mjs +9 -0
- package/dist/theme/components/footer.cjs +1 -1
- package/dist/theme/components/footer.mjs +1 -1
- package/dist/theme/components/header.cjs +2 -2
- package/dist/theme/components/header.d.mts +1 -0
- package/dist/theme/components/header.d.ts +1 -0
- package/dist/theme/components/header.mjs +2 -2
- package/dist/theme/components/home-shell.cjs +2 -2
- package/dist/theme/components/home-shell.mjs +2 -2
- package/dist/theme/components/link.cjs +1 -1
- package/dist/theme/components/link.mjs +1 -1
- package/dist/theme/components/shell-shared.cjs +2 -2
- package/dist/theme/components/shell-shared.mjs +2 -2
- package/dist/theme/create-home-data.cjs +1 -1
- package/dist/theme/create-home-data.mjs +1 -1
- package/dist/theme/slots.cjs +2 -2
- package/dist/theme/slots.mjs +2 -2
- package/dist/theme/types.d.mts +9 -1
- package/dist/theme/types.d.ts +9 -1
- package/dist/theme.cjs +1 -1
- package/dist/theme.d.mts +2 -2
- package/dist/theme.d.ts +2 -2
- package/dist/theme.mjs +1 -1
- package/package.json +4 -4
package/dist/config/defaults.cjs
CHANGED
package/dist/config/defaults.mjs
CHANGED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* name: @blackwork/docs
|
|
3
|
+
* version: v0.2.0
|
|
4
|
+
* description: Next-first documentation framework for Blackwork projects.
|
|
5
|
+
* author: chengpeiquan <chengpeiquan@chengpeiquan.com>
|
|
6
|
+
* homepage: https://chengpeiquan.com
|
|
7
|
+
* license: MIT
|
|
8
|
+
*/
|
|
9
|
+
require(`../_virtual/_rolldown/runtime.cjs`);const e=require(`../config/define-docs-config.cjs`);let t=require(`node:path`),n=require(`node:fs/promises`);const r=(e,t)=>{if(t)return e.content.locales?.[t]??Object.values(e.content.locales??{}).find(e=>e.code===t)},i=e=>{let t=r(e,e.content.defaultLocale);return t?.lang||t?.code||e.content.defaultLocale||`en`},a=(e,n,a)=>{let[o]=(0,t.relative)(a,n).split(t.sep).join(`/`).split(`/`).filter(Boolean),s=r(e,o);return s?.lang||s?.code||i(e)},o=(e,t)=>/<html\b[^>]*\blang="[^"]*"/u.test(e)?e.replace(/<html\b([^>]*)\blang="[^"]*"/u,`<html$1lang="${t}"`):e.replace(/<html\b/u,`<html lang="${t}"`),s=async(e,r,i)=>{let c=await(0,n.readdir)(r,{withFileTypes:!0});for(let l of c){let c=(0,t.join)(r,l.name);if(l.isDirectory()){await s(e,c,i);continue}if(!l.isFile()||!l.name.endsWith(`.html`))continue;let u=await(0,n.readFile)(c,`utf8`),d=o(u,a(e,c,i));d!==u&&await(0,n.writeFile)(c,d)}},c=async({config:n={},outDir:r,rootDir:i=`.`})=>{let a=(0,t.resolve)(i),o=(0,t.resolve)(a,r);await s(e.defineDocsConfig(n,{rootDir:a}),o,o)};exports.processExportedDocs=c;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
|
|
2
|
+
import { DocsConfig, NormalizedDocsConfig } from "../config/types.mjs";
|
|
3
|
+
|
|
4
|
+
//#region src/export/process-exported-docs.d.ts
|
|
5
|
+
interface ProcessExportedDocsOptions {
|
|
6
|
+
config?: DocsConfig | NormalizedDocsConfig;
|
|
7
|
+
outDir: string;
|
|
8
|
+
rootDir?: string;
|
|
9
|
+
}
|
|
10
|
+
declare const processExportedDocs: ({
|
|
11
|
+
config,
|
|
12
|
+
outDir,
|
|
13
|
+
rootDir
|
|
14
|
+
}: ProcessExportedDocsOptions) => Promise<void>;
|
|
15
|
+
//#endregion
|
|
16
|
+
export { ProcessExportedDocsOptions, processExportedDocs };
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
|
|
2
|
+
import { DocsConfig, NormalizedDocsConfig } from "../config/types.js";
|
|
3
|
+
|
|
4
|
+
//#region src/export/process-exported-docs.d.ts
|
|
5
|
+
interface ProcessExportedDocsOptions {
|
|
6
|
+
config?: DocsConfig | NormalizedDocsConfig;
|
|
7
|
+
outDir: string;
|
|
8
|
+
rootDir?: string;
|
|
9
|
+
}
|
|
10
|
+
declare const processExportedDocs: ({
|
|
11
|
+
config,
|
|
12
|
+
outDir,
|
|
13
|
+
rootDir
|
|
14
|
+
}: ProcessExportedDocsOptions) => Promise<void>;
|
|
15
|
+
//#endregion
|
|
16
|
+
export { ProcessExportedDocsOptions, processExportedDocs };
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* name: @blackwork/docs
|
|
3
|
+
* version: v0.2.0
|
|
4
|
+
* description: Next-first documentation framework for Blackwork projects.
|
|
5
|
+
* author: chengpeiquan <chengpeiquan@chengpeiquan.com>
|
|
6
|
+
* homepage: https://chengpeiquan.com
|
|
7
|
+
* license: MIT
|
|
8
|
+
*/
|
|
9
|
+
import{defineDocsConfig as e}from"../config/define-docs-config.mjs";import{join as t,relative as n,resolve as r,sep as i}from"node:path";import{readFile as a,readdir as o,writeFile as s}from"node:fs/promises";const c=(e,t)=>{if(t)return e.content.locales?.[t]??Object.values(e.content.locales??{}).find(e=>e.code===t)},l=e=>{let t=c(e,e.content.defaultLocale);return t?.lang||t?.code||e.content.defaultLocale||`en`},u=(e,t,r)=>{let[a]=n(r,t).split(i).join(`/`).split(`/`).filter(Boolean),o=c(e,a);return o?.lang||o?.code||l(e)},d=(e,t)=>/<html\b[^>]*\blang="[^"]*"/u.test(e)?e.replace(/<html\b([^>]*)\blang="[^"]*"/u,`<html$1lang="${t}"`):e.replace(/<html\b/u,`<html lang="${t}"`),f=async(e,n,r)=>{let i=await o(n,{withFileTypes:!0});for(let o of i){let i=t(n,o.name);if(o.isDirectory()){await f(e,i,r);continue}if(!o.isFile()||!o.name.endsWith(`.html`))continue;let c=await a(i,`utf8`),l=d(c,u(e,i,r));l!==c&&await s(i,l)}},p=async({config:t={},outDir:n,rootDir:i=`.`})=>{let a=r(i),o=r(a,n);await f(e(t,{rootDir:a}),o,o)};export{p as processExportedDocs};
|
package/dist/index.cjs
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* name: @blackwork/docs
|
|
3
|
-
* version: v0.
|
|
3
|
+
* version: v0.2.0
|
|
4
4
|
* description: Next-first documentation framework for Blackwork projects.
|
|
5
5
|
* author: chengpeiquan <chengpeiquan@chengpeiquan.com>
|
|
6
6
|
* homepage: https://chengpeiquan.com
|
|
7
7
|
* license: MIT
|
|
8
8
|
*/
|
|
9
|
-
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`),
|
|
9
|
+
Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require(`./config/define-config.cjs`),t=require(`./config/define-docs-config.cjs`),n=require(`./export/process-exported-docs.cjs`),r=require(`./navigation/build-locale-links.cjs`),i=require(`./metadata/create-doc-metadata.cjs`),a=require(`./navigation/build-pager.cjs`),o=require(`./navigation/build-sidebar.cjs`),s=require(`./next/root-layout.cjs`),c=require(`./routing/build-static-params.cjs`),l=require(`./routing/resolve-docs-route.cjs`),u=require(`./source/create-docs-source.cjs`),d=async(e={})=>(await Promise.resolve().then(()=>require(`./next/metadata.cjs`))).generateMetadata(e),f=async(e={})=>(await Promise.resolve().then(()=>require(`./next/page.cjs`))).generateStaticParams(e),p=async e=>(await Promise.resolve().then(()=>require(`./next/page.cjs`))).DocsPage(e);exports.DocsPage=p,exports.DocsRootLayout=s.DocsRootLayout,exports.buildDocsStaticParams=c.buildDocsStaticParams,exports.buildLocaleLinks=r.buildLocaleLinks,exports.buildPager=a.buildPager,exports.buildSidebar=o.buildSidebar,exports.createDocMetadata=i.createDocMetadata,exports.createDocsSource=u.createDocsSource,exports.defineConfig=e.defineConfig,exports.defineDocsConfig=t.defineDocsConfig,exports.dynamicParams=!1,exports.generateMetadata=d,exports.generateStaticParams=f,exports.processExportedDocs=n.processExportedDocs,exports.resolveDocsRoute=l.resolveDocsRoute;
|
package/dist/index.d.mts
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
import { DocsConfig, DocsContentConfig, DocsContentSectionConfig, DocsHomeConfig, DocsLocaleDefinition, DocsMdxConfig, DocsSectionConfig, DocsSectionLayout, DocsSidebarConfigNode, DocsSidebarGroupConfig, DocsSidebarItemConfig, DocsSidebarLabel, DocsSidebarMode, DocsSiteConfig, DocsSlotsConfig, DocsThemeConfig, NormalizedDocsConfig, NormalizedDocsContentConfig, NormalizedDocsContentSectionConfig } from "./config/types.mjs";
|
|
3
3
|
import { defineConfig } from "./config/define-config.mjs";
|
|
4
4
|
import { DefineDocsConfigOptions, defineDocsConfig } from "./config/define-docs-config.mjs";
|
|
5
|
+
import { ProcessExportedDocsOptions, processExportedDocs } from "./export/process-exported-docs.mjs";
|
|
5
6
|
import { CreateDocsSourceOptions, DocEntry, DocFormat, DocsSource } from "./source/types.mjs";
|
|
6
7
|
import { CreateDocMetadataOptions, DocsMetadata, DocsMetadataAlternates, DocsMetadataRobots, createDocMetadata } from "./metadata/create-doc-metadata.mjs";
|
|
7
8
|
import { BuildLocaleLinksOptions, DocsLocaleLink, buildLocaleLinks } from "./navigation/build-locale-links.mjs";
|
|
@@ -21,4 +22,4 @@ declare const generateMetadata: (options?: GenerateMetadataOptions) => Promise<D
|
|
|
21
22
|
declare const generateStaticParams: (options?: GenerateStaticParamsOptions) => Promise<DocsRouteParams[]>;
|
|
22
23
|
declare const DocsPage: (options: DocsPageProps) => Promise<_$react.ReactElement<unknown, string | _$react.JSXElementConstructor<any>> | Iterable<_$react.ReactNode> | (string | number | bigint | boolean | _$react.ReactPortal | _$react.ReactElement<unknown, string | _$react.JSXElementConstructor<any>> | Iterable<_$react.ReactNode> | null | undefined)>;
|
|
23
24
|
//#endregion
|
|
24
|
-
export { type BuildDocsStaticParamsOptions, type BuildLocaleLinksOptions, type BuildPagerOptions, type BuildSidebarOptions, type CreateDocMetadataOptions, type CreateDocsSourceOptions, type DefineDocsConfigOptions, type DocEntry, type DocFormat, type DocsConfig, type DocsContentConfig, type DocsContentSectionConfig, type DocsHomeConfig, type DocsLocaleDefinition, type DocsLocaleLink, type DocsMdxConfig, type DocsMetadata, type DocsMetadataAlternates, type DocsMetadataRobots, DocsPage, type DocsPageProps, type DocsPager, type DocsPagerLink, DocsRootLayout, type DocsRootLayoutProps, type DocsRouteParams, type DocsRouteResolution, type DocsSectionConfig, type DocsSectionLayout, type DocsSidebarConfigNode, type DocsSidebarGroupConfig, type DocsSidebarItem, type DocsSidebarItemConfig, type DocsSidebarLabel, type DocsSidebarMode, type DocsSiteConfig, type DocsSlotsConfig, type DocsSource, type DocsThemeConfig, type GenerateMetadataOptions, type GenerateStaticParamsOptions, type NormalizedDocsConfig, type NormalizedDocsContentConfig, type NormalizedDocsContentSectionConfig, type ResolveDocsRouteOptions, type ResolvedDocsNotFoundRoute, type ResolvedDocsPageRoute, type ResolvedDocsRedirectRoute, buildDocsStaticParams, buildLocaleLinks, buildPager, buildSidebar, createDocMetadata, createDocsSource, defineConfig, defineDocsConfig, dynamicParams, generateMetadata, generateStaticParams, resolveDocsRoute };
|
|
25
|
+
export { type BuildDocsStaticParamsOptions, type BuildLocaleLinksOptions, type BuildPagerOptions, type BuildSidebarOptions, type CreateDocMetadataOptions, type CreateDocsSourceOptions, type DefineDocsConfigOptions, type DocEntry, type DocFormat, type DocsConfig, type DocsContentConfig, type DocsContentSectionConfig, type DocsHomeConfig, type DocsLocaleDefinition, type DocsLocaleLink, type DocsMdxConfig, type DocsMetadata, type DocsMetadataAlternates, type DocsMetadataRobots, DocsPage, type DocsPageProps, type DocsPager, type DocsPagerLink, DocsRootLayout, type DocsRootLayoutProps, type DocsRouteParams, type DocsRouteResolution, type DocsSectionConfig, type DocsSectionLayout, type DocsSidebarConfigNode, type DocsSidebarGroupConfig, type DocsSidebarItem, type DocsSidebarItemConfig, type DocsSidebarLabel, type DocsSidebarMode, type DocsSiteConfig, type DocsSlotsConfig, type DocsSource, type DocsThemeConfig, type GenerateMetadataOptions, type GenerateStaticParamsOptions, type NormalizedDocsConfig, type NormalizedDocsContentConfig, type NormalizedDocsContentSectionConfig, type ProcessExportedDocsOptions, type ResolveDocsRouteOptions, type ResolvedDocsNotFoundRoute, type ResolvedDocsPageRoute, type ResolvedDocsRedirectRoute, buildDocsStaticParams, buildLocaleLinks, buildPager, buildSidebar, createDocMetadata, createDocsSource, defineConfig, defineDocsConfig, dynamicParams, generateMetadata, generateStaticParams, processExportedDocs, resolveDocsRoute };
|
package/dist/index.d.ts
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
import { DocsConfig, DocsContentConfig, DocsContentSectionConfig, DocsHomeConfig, DocsLocaleDefinition, DocsMdxConfig, DocsSectionConfig, DocsSectionLayout, DocsSidebarConfigNode, DocsSidebarGroupConfig, DocsSidebarItemConfig, DocsSidebarLabel, DocsSidebarMode, DocsSiteConfig, DocsSlotsConfig, DocsThemeConfig, NormalizedDocsConfig, NormalizedDocsContentConfig, NormalizedDocsContentSectionConfig } from "./config/types.js";
|
|
3
3
|
import { defineConfig } from "./config/define-config.js";
|
|
4
4
|
import { DefineDocsConfigOptions, defineDocsConfig } from "./config/define-docs-config.js";
|
|
5
|
+
import { ProcessExportedDocsOptions, processExportedDocs } from "./export/process-exported-docs.js";
|
|
5
6
|
import { CreateDocsSourceOptions, DocEntry, DocFormat, DocsSource } from "./source/types.js";
|
|
6
7
|
import { CreateDocMetadataOptions, DocsMetadata, DocsMetadataAlternates, DocsMetadataRobots, createDocMetadata } from "./metadata/create-doc-metadata.js";
|
|
7
8
|
import { BuildLocaleLinksOptions, DocsLocaleLink, buildLocaleLinks } from "./navigation/build-locale-links.js";
|
|
@@ -21,4 +22,4 @@ declare const generateMetadata: (options?: GenerateMetadataOptions) => Promise<D
|
|
|
21
22
|
declare const generateStaticParams: (options?: GenerateStaticParamsOptions) => Promise<DocsRouteParams[]>;
|
|
22
23
|
declare const DocsPage: (options: DocsPageProps) => Promise<_$react.ReactElement<unknown, string | _$react.JSXElementConstructor<any>> | Iterable<_$react.ReactNode> | (string | number | bigint | boolean | _$react.ReactPortal | _$react.ReactElement<unknown, string | _$react.JSXElementConstructor<any>> | Iterable<_$react.ReactNode> | null | undefined)>;
|
|
23
24
|
//#endregion
|
|
24
|
-
export { type BuildDocsStaticParamsOptions, type BuildLocaleLinksOptions, type BuildPagerOptions, type BuildSidebarOptions, type CreateDocMetadataOptions, type CreateDocsSourceOptions, type DefineDocsConfigOptions, type DocEntry, type DocFormat, type DocsConfig, type DocsContentConfig, type DocsContentSectionConfig, type DocsHomeConfig, type DocsLocaleDefinition, type DocsLocaleLink, type DocsMdxConfig, type DocsMetadata, type DocsMetadataAlternates, type DocsMetadataRobots, DocsPage, type DocsPageProps, type DocsPager, type DocsPagerLink, DocsRootLayout, type DocsRootLayoutProps, type DocsRouteParams, type DocsRouteResolution, type DocsSectionConfig, type DocsSectionLayout, type DocsSidebarConfigNode, type DocsSidebarGroupConfig, type DocsSidebarItem, type DocsSidebarItemConfig, type DocsSidebarLabel, type DocsSidebarMode, type DocsSiteConfig, type DocsSlotsConfig, type DocsSource, type DocsThemeConfig, type GenerateMetadataOptions, type GenerateStaticParamsOptions, type NormalizedDocsConfig, type NormalizedDocsContentConfig, type NormalizedDocsContentSectionConfig, type ResolveDocsRouteOptions, type ResolvedDocsNotFoundRoute, type ResolvedDocsPageRoute, type ResolvedDocsRedirectRoute, buildDocsStaticParams, buildLocaleLinks, buildPager, buildSidebar, createDocMetadata, createDocsSource, defineConfig, defineDocsConfig, dynamicParams, generateMetadata, generateStaticParams, resolveDocsRoute };
|
|
25
|
+
export { type BuildDocsStaticParamsOptions, type BuildLocaleLinksOptions, type BuildPagerOptions, type BuildSidebarOptions, type CreateDocMetadataOptions, type CreateDocsSourceOptions, type DefineDocsConfigOptions, type DocEntry, type DocFormat, type DocsConfig, type DocsContentConfig, type DocsContentSectionConfig, type DocsHomeConfig, type DocsLocaleDefinition, type DocsLocaleLink, type DocsMdxConfig, type DocsMetadata, type DocsMetadataAlternates, type DocsMetadataRobots, DocsPage, type DocsPageProps, type DocsPager, type DocsPagerLink, DocsRootLayout, type DocsRootLayoutProps, type DocsRouteParams, type DocsRouteResolution, type DocsSectionConfig, type DocsSectionLayout, type DocsSidebarConfigNode, type DocsSidebarGroupConfig, type DocsSidebarItem, type DocsSidebarItemConfig, type DocsSidebarLabel, type DocsSidebarMode, type DocsSiteConfig, type DocsSlotsConfig, type DocsSource, type DocsThemeConfig, type GenerateMetadataOptions, type GenerateStaticParamsOptions, type NormalizedDocsConfig, type NormalizedDocsContentConfig, type NormalizedDocsContentSectionConfig, type ProcessExportedDocsOptions, type ResolveDocsRouteOptions, type ResolvedDocsNotFoundRoute, type ResolvedDocsPageRoute, type ResolvedDocsRedirectRoute, buildDocsStaticParams, buildLocaleLinks, buildPager, buildSidebar, createDocMetadata, createDocsSource, defineConfig, defineDocsConfig, dynamicParams, generateMetadata, generateStaticParams, processExportedDocs, resolveDocsRoute };
|
package/dist/index.mjs
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* name: @blackwork/docs
|
|
3
|
-
* version: v0.
|
|
3
|
+
* version: v0.2.0
|
|
4
4
|
* description: Next-first documentation framework for Blackwork projects.
|
|
5
5
|
* author: chengpeiquan <chengpeiquan@chengpeiquan.com>
|
|
6
6
|
* homepage: https://chengpeiquan.com
|
|
7
7
|
* license: MIT
|
|
8
8
|
*/
|
|
9
|
-
import{defineConfig as e}from"./config/define-config.mjs";import{defineDocsConfig as t}from"./config/define-docs-config.mjs";import{
|
|
9
|
+
import{defineConfig as e}from"./config/define-config.mjs";import{defineDocsConfig as t}from"./config/define-docs-config.mjs";import{processExportedDocs as n}from"./export/process-exported-docs.mjs";import{buildLocaleLinks as r}from"./navigation/build-locale-links.mjs";import{createDocMetadata as i}from"./metadata/create-doc-metadata.mjs";import{buildPager as a}from"./navigation/build-pager.mjs";import{buildSidebar as o}from"./navigation/build-sidebar.mjs";import{DocsRootLayout as s}from"./next/root-layout.mjs";import{buildDocsStaticParams as c}from"./routing/build-static-params.mjs";import{resolveDocsRoute as l}from"./routing/resolve-docs-route.mjs";import{createDocsSource as u}from"./source/create-docs-source.mjs";const d=!1,f=async(e={})=>(await import(`./next/metadata.mjs`)).generateMetadata(e),p=async(e={})=>(await import(`./next/page.mjs`)).generateStaticParams(e),m=async e=>(await import(`./next/page.mjs`)).DocsPage(e);export{m as DocsPage,s as DocsRootLayout,c as buildDocsStaticParams,r as buildLocaleLinks,a as buildPager,o as buildSidebar,i as createDocMetadata,u as createDocsSource,e as defineConfig,t as defineDocsConfig,d as dynamicParams,f as generateMetadata,p as generateStaticParams,n as processExportedDocs,l as resolveDocsRoute};
|
package/dist/next/context.cjs
CHANGED
package/dist/next/context.mjs
CHANGED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* name: @blackwork/docs
|
|
3
|
+
* version: v0.2.0
|
|
4
|
+
* description: Next-first documentation framework for Blackwork projects.
|
|
5
|
+
* author: chengpeiquan <chengpeiquan@chengpeiquan.com>
|
|
6
|
+
* homepage: https://chengpeiquan.com
|
|
7
|
+
* license: MIT
|
|
8
|
+
*/
|
|
9
|
+
"use client";require(`../_virtual/_rolldown/runtime.cjs`);const e=require(`./resolve-document-lang.cjs`);let t=require(`next/navigation.js`),n=require(`react`);const r=({content:r})=>{let i=(0,t.usePathname)();return(0,n.useEffect)(()=>{if(typeof document>`u`)return;let t=e.resolveDocumentLang({config:{content:r},pathname:i});typeof t==`string`&&document.documentElement.lang!==t&&(document.documentElement.lang=t)},[r,i]),null};exports.DocsDocumentLangSync=r;
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* name: @blackwork/docs
|
|
3
|
+
* version: v0.2.0
|
|
4
|
+
* description: Next-first documentation framework for Blackwork projects.
|
|
5
|
+
* author: chengpeiquan <chengpeiquan@chengpeiquan.com>
|
|
6
|
+
* homepage: https://chengpeiquan.com
|
|
7
|
+
* license: MIT
|
|
8
|
+
*/
|
|
9
|
+
"use client";import{resolveDocumentLang as e}from"./resolve-document-lang.mjs";import{usePathname as t}from"next/navigation.js";import{useEffect as n}from"react";const r=({content:r})=>{let i=t();return n(()=>{if(typeof document>`u`)return;let t=e({config:{content:r},pathname:i});typeof t==`string`&&document.documentElement.lang!==t&&(document.documentElement.lang=t)},[r,i]),null};export{r as DocsDocumentLangSync};
|
package/dist/next/metadata.cjs
CHANGED
package/dist/next/metadata.mjs
CHANGED
package/dist/next/page.cjs
CHANGED
package/dist/next/page.mjs
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* name: @blackwork/docs
|
|
3
|
-
* version: v0.
|
|
3
|
+
* version: v0.2.0
|
|
4
4
|
* description: Next-first documentation framework for Blackwork projects.
|
|
5
5
|
* author: chengpeiquan <chengpeiquan@chengpeiquan.com>
|
|
6
6
|
* homepage: https://chengpeiquan.com
|
|
7
7
|
* license: MIT
|
|
8
8
|
*/
|
|
9
|
-
require(`../_virtual/_rolldown/runtime.cjs`);const e=require(`../config/define-config.cjs`),t=require(`../theme/components/docs-scroll-reset.cjs`),n=require(`./resolve-document-lang.cjs`);let
|
|
9
|
+
require(`../_virtual/_rolldown/runtime.cjs`);const e=require(`../config/define-config.cjs`),t=require(`../theme/components/docs-scroll-reset.cjs`),n=require(`./resolve-document-lang.cjs`),r=require(`./document-lang-sync.cjs`);let i=require(`blackwork`),a=require(`react/jsx-runtime`);const o=async e=>{let t=(e?await e:void 0)?.slug?.filter(e=>e.length>0)??[];return t.length>0?`/${t.join(`/`)}`:`/`},s=e=>e===`light`||e===`dark`,c=e=>{let t=typeof e.storageKey==`string`?e.storageKey:void 0,n=s(e.defaultTheme)?e.defaultTheme:void 0;return{...t?{storageKey:t}:{},...n?{defaultTheme:n}:{}}},l=async({children:s,config:l,params:u})=>{let d=e.defineConfig(l),f=n.resolveDocumentLang({config:d,pathname:await o(u)}),p=c(d.theme);return(0,a.jsxs)(`html`,{lang:f,suppressHydrationWarning:!0,children:[(0,a.jsx)(`head`,{children:(0,a.jsx)(i.ThemeScript,{...p})}),(0,a.jsx)(`body`,{className:`flex min-h-screen w-screen flex-col`,children:(0,a.jsxs)(i.ThemeProvider,{...p,children:[(0,a.jsx)(r.DocsDocumentLangSync,{content:d.content}),(0,a.jsx)(t.DocsScrollReset,{}),s]})})]})};exports.DocsRootLayout=l;
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* name: @blackwork/docs
|
|
3
|
-
* version: v0.
|
|
3
|
+
* version: v0.2.0
|
|
4
4
|
* description: Next-first documentation framework for Blackwork projects.
|
|
5
5
|
* author: chengpeiquan <chengpeiquan@chengpeiquan.com>
|
|
6
6
|
* homepage: https://chengpeiquan.com
|
|
7
7
|
* license: MIT
|
|
8
8
|
*/
|
|
9
|
-
import{defineConfig as e}from"../config/define-config.mjs";import{DocsScrollReset as t}from"../theme/components/docs-scroll-reset.mjs";import{resolveDocumentLang as n}from"./resolve-document-lang.mjs";import{ThemeProvider as
|
|
9
|
+
import{defineConfig as e}from"../config/define-config.mjs";import{DocsScrollReset as t}from"../theme/components/docs-scroll-reset.mjs";import{resolveDocumentLang as n}from"./resolve-document-lang.mjs";import{DocsDocumentLangSync as r}from"./document-lang-sync.mjs";import{ThemeProvider as i,ThemeScript as a}from"blackwork";import{jsx as o,jsxs as s}from"react/jsx-runtime";const c=async e=>{let t=(e?await e:void 0)?.slug?.filter(e=>e.length>0)??[];return t.length>0?`/${t.join(`/`)}`:`/`},l=e=>e===`light`||e===`dark`,u=e=>{let t=typeof e.storageKey==`string`?e.storageKey:void 0,n=l(e.defaultTheme)?e.defaultTheme:void 0;return{...t?{storageKey:t}:{},...n?{defaultTheme:n}:{}}},d=async({children:l,config:d,params:f})=>{let p=e(d),m=n({config:p,pathname:await c(f)}),h=u(p.theme);return s(`html`,{lang:m,suppressHydrationWarning:!0,children:[o(`head`,{children:o(a,{...h})}),o(`body`,{className:`flex min-h-screen w-screen flex-col`,children:s(i,{...h,children:[o(r,{content:p.content}),o(t,{}),l]})})]})};export{d as DocsRootLayout};
|
package/dist/next.cjs
CHANGED
package/dist/next.mjs
CHANGED