@blackwork/docs 0.2.0 → 0.4.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/README.md +24 -1
- 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/config/types.d.mts +11 -1
- package/dist/config/types.d.ts +11 -1
- package/dist/export/process-exported-docs.cjs +1 -1
- package/dist/export/process-exported-docs.mjs +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.d.mts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.mjs +1 -1
- 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.d.mts +1 -1
- package/dist/metadata/create-doc-metadata.d.ts +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.d.mts +1 -1
- package/dist/navigation/build-locale-links.d.ts +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.d.mts +1 -1
- package/dist/navigation/build-sidebar.d.ts +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 +1 -1
- package/dist/next/document-lang-sync.mjs +1 -1
- 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 +1 -1
- package/dist/next/root-layout.mjs +1 -1
- 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/tailwind.css +1 -0
- package/dist/theme/components/content-layout.cjs +9 -0
- package/dist/theme/components/content-layout.d.mts +15 -0
- package/dist/theme/components/content-layout.d.ts +15 -0
- package/dist/theme/components/content-layout.mjs +9 -0
- package/dist/theme/components/content-shell.cjs +2 -2
- package/dist/theme/components/content-shell.d.mts +1 -1
- package/dist/theme/components/content-shell.d.ts +1 -1
- package/dist/theme/components/content-shell.mjs +2 -2
- package/dist/theme/components/docs-rail-scroll-state.cjs +2 -2
- package/dist/theme/components/docs-rail-scroll-state.mjs +2 -2
- package/dist/theme/components/docs-rail-scroll.cjs +2 -2
- package/dist/theme/components/docs-rail-scroll.mjs +2 -2
- 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 +1 -1
- package/dist/theme/components/docs-scroll-to-top.mjs +1 -1
- package/dist/theme/components/docs-shell.cjs +2 -2
- package/dist/theme/components/docs-shell.d.mts +1 -1
- package/dist/theme/components/docs-shell.d.ts +1 -1
- 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.d.mts +32 -0
- package/dist/theme/components/docs-toc.d.ts +32 -0
- package/dist/theme/components/docs-toc.mjs +2 -2
- package/dist/theme/components/floating-actions.cjs +1 -1
- package/dist/theme/components/floating-actions.mjs +1 -1
- package/dist/theme/components/footer.cjs +1 -1
- package/dist/theme/components/footer.mjs +1 -1
- package/dist/theme/components/header.cjs +1 -1
- package/dist/theme/components/header.mjs +1 -1
- package/dist/theme/components/home-shell.cjs +1 -1
- package/dist/theme/components/home-shell.d.mts +1 -1
- package/dist/theme/components/home-shell.d.ts +1 -1
- package/dist/theme/components/home-shell.mjs +1 -1
- 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.d.mts +1 -1
- package/dist/theme/create-home-data.d.ts +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 +6 -1
- package/dist/theme/types.d.ts +6 -1
- package/dist/theme.cjs +2 -2
- package/dist/theme.d.mts +4 -2
- package/dist/theme.d.ts +4 -2
- package/dist/theme.mjs +2 -2
- package/package.json +8 -7
package/README.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# @blackwork/docs
|
|
2
2
|
|
|
3
|
+
<p>
|
|
4
|
+
<a href='https://www.npmjs.com/package/@blackwork/docs'>
|
|
5
|
+
<img src="https://img.shields.io/npm/v/@blackwork/docs?color=333&label=npm" />
|
|
6
|
+
</a>
|
|
7
|
+
<a href="https://www.npmjs.com/package/@blackwork/docs" target="__blank">
|
|
8
|
+
<img src="https://img.shields.io/npm/dt/@blackwork/docs?color=333&label=downloads" />
|
|
9
|
+
</a>
|
|
10
|
+
<a href="https://github.com/chengpeiquan/blackwork" target="__blank">
|
|
11
|
+
<img alt="GitHub stars" src="https://img.shields.io/github/stars/chengpeiquan/blackwork?style=social" />
|
|
12
|
+
</a>
|
|
13
|
+
</p>
|
|
14
|
+
|
|
3
15
|
`@blackwork/docs` is a Next.js-first documentation framework for the Blackwork ecosystem.
|
|
4
16
|
|
|
5
17
|
It sits one layer above `blackwork` and `@blackwork/machine`:
|
|
@@ -223,7 +235,6 @@ overrides should stay in `docs.config.ts`.
|
|
|
223
235
|
```tsx
|
|
224
236
|
import { DocsRootLayout } from '@blackwork/docs'
|
|
225
237
|
import { docsConfig } from '../../docs.config'
|
|
226
|
-
import 'blackwork/ui-globals.css'
|
|
227
238
|
import './globals.css'
|
|
228
239
|
|
|
229
240
|
export default function RootLayout({
|
|
@@ -292,6 +303,8 @@ export default function DocsRoutePage({
|
|
|
292
303
|
|
|
293
304
|
## Tailwind Setup
|
|
294
305
|
|
|
306
|
+
### Tailwind CSS v3
|
|
307
|
+
|
|
295
308
|
If your app uses Tailwind CSS, include both `blackwork` and `@blackwork/docs` build output in the content scan:
|
|
296
309
|
|
|
297
310
|
```ts
|
|
@@ -313,6 +326,16 @@ export default {
|
|
|
313
326
|
} satisfies Config
|
|
314
327
|
```
|
|
315
328
|
|
|
329
|
+
### Tailwind CSS v4
|
|
330
|
+
|
|
331
|
+
Import the Blackwork and docs package Tailwind entries explicitly:
|
|
332
|
+
|
|
333
|
+
```css
|
|
334
|
+
@import 'tailwindcss';
|
|
335
|
+
@import 'blackwork/tailwind.css';
|
|
336
|
+
@import '@blackwork/docs/tailwind.css';
|
|
337
|
+
```
|
|
338
|
+
|
|
316
339
|
## Difference From `@blackwork/machine`
|
|
317
340
|
|
|
318
341
|
Use `@blackwork/machine` when you only need Markdown or MDX compilation:
|
package/dist/config/defaults.cjs
CHANGED
package/dist/config/defaults.mjs
CHANGED
package/dist/config/types.d.mts
CHANGED
|
@@ -38,7 +38,17 @@ interface DocsContentConfig {
|
|
|
38
38
|
locales?: Record<string, DocsLocaleDefinition>;
|
|
39
39
|
sections?: Record<string, DocsContentSectionConfig>;
|
|
40
40
|
}
|
|
41
|
-
type
|
|
41
|
+
type DocsThemeLocalizedLabel = string | Record<string, string>;
|
|
42
|
+
interface DocsThemeTocConfig {
|
|
43
|
+
collapseLabel?: DocsThemeLocalizedLabel;
|
|
44
|
+
expandLabel?: DocsThemeLocalizedLabel;
|
|
45
|
+
openLabel?: DocsThemeLocalizedLabel;
|
|
46
|
+
title?: DocsThemeLocalizedLabel;
|
|
47
|
+
}
|
|
48
|
+
interface DocsThemeConfig {
|
|
49
|
+
[key: string]: unknown;
|
|
50
|
+
toc?: DocsThemeTocConfig;
|
|
51
|
+
}
|
|
42
52
|
type DocsSectionConfig = Record<string, unknown>;
|
|
43
53
|
type DocsHomeConfig = DocsHomeConfig$1;
|
|
44
54
|
interface DocsMdxConfig {
|
package/dist/config/types.d.ts
CHANGED
|
@@ -38,7 +38,17 @@ interface DocsContentConfig {
|
|
|
38
38
|
locales?: Record<string, DocsLocaleDefinition>;
|
|
39
39
|
sections?: Record<string, DocsContentSectionConfig>;
|
|
40
40
|
}
|
|
41
|
-
type
|
|
41
|
+
type DocsThemeLocalizedLabel = string | Record<string, string>;
|
|
42
|
+
interface DocsThemeTocConfig {
|
|
43
|
+
collapseLabel?: DocsThemeLocalizedLabel;
|
|
44
|
+
expandLabel?: DocsThemeLocalizedLabel;
|
|
45
|
+
openLabel?: DocsThemeLocalizedLabel;
|
|
46
|
+
title?: DocsThemeLocalizedLabel;
|
|
47
|
+
}
|
|
48
|
+
interface DocsThemeConfig {
|
|
49
|
+
[key: string]: unknown;
|
|
50
|
+
toc?: DocsThemeTocConfig;
|
|
51
|
+
}
|
|
42
52
|
type DocsSectionConfig = Record<string, unknown>;
|
|
43
53
|
type DocsHomeConfig = DocsHomeConfig$1;
|
|
44
54
|
interface DocsMdxConfig {
|
package/dist/index.cjs
CHANGED
package/dist/index.d.mts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
|
|
2
|
+
import { CreateDocsSourceOptions, DocEntry, DocFormat, DocsSource } from "./source/types.mjs";
|
|
2
3
|
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
4
|
import { defineConfig } from "./config/define-config.mjs";
|
|
4
5
|
import { DefineDocsConfigOptions, defineDocsConfig } from "./config/define-docs-config.mjs";
|
|
5
6
|
import { ProcessExportedDocsOptions, processExportedDocs } from "./export/process-exported-docs.mjs";
|
|
6
|
-
import { CreateDocsSourceOptions, DocEntry, DocFormat, DocsSource } from "./source/types.mjs";
|
|
7
7
|
import { CreateDocMetadataOptions, DocsMetadata, DocsMetadataAlternates, DocsMetadataRobots, createDocMetadata } from "./metadata/create-doc-metadata.mjs";
|
|
8
8
|
import { BuildLocaleLinksOptions, DocsLocaleLink, buildLocaleLinks } from "./navigation/build-locale-links.mjs";
|
|
9
9
|
import { BuildPagerOptions, DocsPager, DocsPagerLink, buildPager } from "./navigation/build-pager.mjs";
|
package/dist/index.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
|
|
2
|
+
import { CreateDocsSourceOptions, DocEntry, DocFormat, DocsSource } from "./source/types.js";
|
|
2
3
|
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
4
|
import { defineConfig } from "./config/define-config.js";
|
|
4
5
|
import { DefineDocsConfigOptions, defineDocsConfig } from "./config/define-docs-config.js";
|
|
5
6
|
import { ProcessExportedDocsOptions, processExportedDocs } from "./export/process-exported-docs.js";
|
|
6
|
-
import { CreateDocsSourceOptions, DocEntry, DocFormat, DocsSource } from "./source/types.js";
|
|
7
7
|
import { CreateDocMetadataOptions, DocsMetadata, DocsMetadataAlternates, DocsMetadataRobots, createDocMetadata } from "./metadata/create-doc-metadata.js";
|
|
8
8
|
import { BuildLocaleLinksOptions, DocsLocaleLink, buildLocaleLinks } from "./navigation/build-locale-links.js";
|
|
9
9
|
import { BuildPagerOptions, DocsPager, DocsPagerLink, buildPager } from "./navigation/build-pager.js";
|
package/dist/index.mjs
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
|
|
2
|
-
import { DocsConfig, NormalizedDocsConfig } from "../config/types.mjs";
|
|
3
2
|
import { DocEntry, DocsSource } from "../source/types.mjs";
|
|
3
|
+
import { DocsConfig, NormalizedDocsConfig } from "../config/types.mjs";
|
|
4
4
|
|
|
5
5
|
//#region src/metadata/create-doc-metadata.d.ts
|
|
6
6
|
interface DocsMetadataAlternates {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
|
|
2
|
-
import { DocsConfig, NormalizedDocsConfig } from "../config/types.js";
|
|
3
2
|
import { DocEntry, DocsSource } from "../source/types.js";
|
|
3
|
+
import { DocsConfig, NormalizedDocsConfig } from "../config/types.js";
|
|
4
4
|
|
|
5
5
|
//#region src/metadata/create-doc-metadata.d.ts
|
|
6
6
|
interface DocsMetadataAlternates {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
|
|
2
|
-
import { DocsConfig, NormalizedDocsConfig } from "../config/types.mjs";
|
|
3
2
|
import { DocEntry, DocsSource } from "../source/types.mjs";
|
|
3
|
+
import { DocsConfig, NormalizedDocsConfig } from "../config/types.mjs";
|
|
4
4
|
|
|
5
5
|
//#region src/navigation/build-locale-links.d.ts
|
|
6
6
|
interface DocsLocaleLink {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
|
|
2
|
-
import { DocsConfig, NormalizedDocsConfig } from "../config/types.js";
|
|
3
2
|
import { DocEntry, DocsSource } from "../source/types.js";
|
|
3
|
+
import { DocsConfig, NormalizedDocsConfig } from "../config/types.js";
|
|
4
4
|
|
|
5
5
|
//#region src/navigation/build-locale-links.d.ts
|
|
6
6
|
interface DocsLocaleLink {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
|
|
2
|
-
import { DocsConfig, NormalizedDocsConfig } from "../config/types.mjs";
|
|
3
2
|
import { DocEntry } from "../source/types.mjs";
|
|
3
|
+
import { DocsConfig, NormalizedDocsConfig } from "../config/types.mjs";
|
|
4
4
|
|
|
5
5
|
//#region src/navigation/build-sidebar.d.ts
|
|
6
6
|
interface DocsSidebarItem {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
|
|
2
|
-
import { DocsConfig, NormalizedDocsConfig } from "../config/types.js";
|
|
3
2
|
import { DocEntry } from "../source/types.js";
|
|
3
|
+
import { DocsConfig, NormalizedDocsConfig } from "../config/types.js";
|
|
4
4
|
|
|
5
5
|
//#region src/navigation/build-sidebar.d.ts
|
|
6
6
|
interface DocsSidebarItem {
|
package/dist/next/context.cjs
CHANGED
package/dist/next/context.mjs
CHANGED
package/dist/next/metadata.cjs
CHANGED
package/dist/next/metadata.mjs
CHANGED
package/dist/next/page.cjs
CHANGED
package/dist/next/page.mjs
CHANGED
package/dist/next.cjs
CHANGED
package/dist/next.mjs
CHANGED