@takazudo/zudo-doc 3.0.0 → 3.1.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/CHANGELOG.md +1038 -0
- package/README.md +4 -0
- package/dist/doc-page-renderer/index.d.ts +1 -0
- package/dist/doc-page-renderer/index.js +2 -0
- package/dist/doc-page-shell/index.d.ts +2 -0
- package/dist/doc-page-shell/index.js +2 -0
- package/dist/doclayout/doc-layout.d.ts +9 -0
- package/dist/doclayout/doc-layout.js +2 -0
- package/dist/features.css +19 -0
- package/dist/home-page/index.d.ts +8 -0
- package/dist/home-page/index.js +3 -1
- package/dist/integrations/changelog/emit.d.ts +2 -0
- package/dist/integrations/changelog/emit.js +24 -0
- package/dist/integrations/changelog/generate.d.ts +2 -0
- package/dist/integrations/changelog/generate.js +24 -0
- package/dist/integrations/changelog/index.d.ts +5 -0
- package/dist/integrations/changelog/index.js +11 -0
- package/dist/integrations/changelog/load.d.ts +3 -0
- package/dist/integrations/changelog/load.js +79 -0
- package/dist/integrations/changelog/sanitize.d.ts +10 -0
- package/dist/integrations/changelog/sanitize.js +24 -0
- package/dist/integrations/changelog/types.d.ts +31 -0
- package/dist/integrations/changelog/types.js +0 -0
- package/dist/plugins/changelog.d.ts +3 -0
- package/dist/plugins/changelog.js +17 -0
- package/dist/preset.d.ts +7 -0
- package/dist/preset.js +8 -0
- package/dist/safelist.css +1 -1
- package/dist/settings.d.ts +11 -0
- package/package.json +16 -7
package/README.md
CHANGED
|
@@ -2,6 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
Framework primitives that sit on top of zfb's engine — the framework layer that zfb deliberately doesn't ship (per ADR-003).
|
|
4
4
|
|
|
5
|
+
Release history is shipped as `CHANGELOG.md` in the npm package. The file is
|
|
6
|
+
generated from the repository's changelog MDX pages; edit those source pages
|
|
7
|
+
instead of editing the generated markdown directly.
|
|
8
|
+
|
|
5
9
|
This package provides the missing-by-design framework concerns:
|
|
6
10
|
|
|
7
11
|
- **Sidebar tree builder** (`./sidebar-tree`) — turns collection entries + `_category_.json` into a sidebar `SidebarNode[]`.
|
|
@@ -47,6 +47,7 @@ function createRenderDocPage(ctx) {
|
|
|
47
47
|
const standalone = entryData?.standalone;
|
|
48
48
|
const hideSidebar = entryData ? entryData.hide_sidebar || standalone : void 0;
|
|
49
49
|
const hideToc = entryData ? entryData.hide_toc || standalone : void 0;
|
|
50
|
+
const contentWide = entryData ? entryData.wide : void 0;
|
|
50
51
|
const sidebarPersistKey = hideSidebar ? void 0 : `sidebar-${locale}-${navSection ?? "default"}`;
|
|
51
52
|
const ContentComponent = props.kind === "entry" ? props.entry.Content : null;
|
|
52
53
|
return /* @__PURE__ */ jsx(
|
|
@@ -66,6 +67,7 @@ function createRenderDocPage(ctx) {
|
|
|
66
67
|
sidebarPersistKey,
|
|
67
68
|
hideSidebar,
|
|
68
69
|
hideToc,
|
|
70
|
+
contentWide,
|
|
69
71
|
currentPath,
|
|
70
72
|
currentVersion: version?.slug,
|
|
71
73
|
versionSwitcher: buildInlineVersionSwitcher(slug, locale, version?.slug),
|
|
@@ -52,6 +52,8 @@ export interface DocPageShellProps {
|
|
|
52
52
|
hideSidebar?: boolean;
|
|
53
53
|
/** Whether to hide the TOC (entry frontmatter). */
|
|
54
54
|
hideToc?: boolean;
|
|
55
|
+
/** Whether to widen the content band to the wide layout (entry frontmatter `wide`). */
|
|
56
|
+
contentWide?: boolean;
|
|
55
57
|
/** Path of THIS page used by Header/Sidebar to mark the active item. */
|
|
56
58
|
currentPath: string;
|
|
57
59
|
/** Version slug for Header/Sidebar active-state, or undefined on latest routes. */
|
|
@@ -50,6 +50,7 @@ function createDocPageShell(ctx) {
|
|
|
50
50
|
sidebarPersistKey,
|
|
51
51
|
hideSidebar,
|
|
52
52
|
hideToc,
|
|
53
|
+
contentWide,
|
|
53
54
|
currentPath,
|
|
54
55
|
currentVersion,
|
|
55
56
|
versionSwitcher,
|
|
@@ -86,6 +87,7 @@ function createDocPageShell(ctx) {
|
|
|
86
87
|
noindex: settings.noindex,
|
|
87
88
|
hideSidebar,
|
|
88
89
|
hideToc,
|
|
90
|
+
contentWide,
|
|
89
91
|
headings,
|
|
90
92
|
canonical,
|
|
91
93
|
sidebarPersistKey,
|
|
@@ -85,6 +85,15 @@ export interface DocLayoutProps extends DocLayoutHtmlAttrs {
|
|
|
85
85
|
toc?: ComponentChildren;
|
|
86
86
|
/** Hide the TOC (both desktop and mobile) regardless of slot value. */
|
|
87
87
|
hideToc?: boolean;
|
|
88
|
+
/**
|
|
89
|
+
* Opt the content band into the **wide** layout. Sets `data-zd-wide` on
|
|
90
|
+
* `.zd-doc-content-band`, letting the reading column fill most of the
|
|
91
|
+
* viewport instead of the standard capped width (see the
|
|
92
|
+
* `.zd-doc-content-band[data-zd-wide]` rule in `features.css`). Mirrors the
|
|
93
|
+
* `wide` page frontmatter flag; also passed directly by route components
|
|
94
|
+
* (home page, etc.) that want a full-width grid. Defaults to `false`.
|
|
95
|
+
*/
|
|
96
|
+
contentWide?: boolean;
|
|
88
97
|
/** Optional footer rendered below the content. */
|
|
89
98
|
footer?: ComponentChildren;
|
|
90
99
|
/**
|
|
@@ -22,6 +22,7 @@ function DocLayout(props) {
|
|
|
22
22
|
afterContent,
|
|
23
23
|
toc,
|
|
24
24
|
hideToc = false,
|
|
25
|
+
contentWide = false,
|
|
25
26
|
footer,
|
|
26
27
|
bodyEndComponents,
|
|
27
28
|
bodyEndScripts,
|
|
@@ -72,6 +73,7 @@ function DocLayout(props) {
|
|
|
72
73
|
{
|
|
73
74
|
class: "zd-doc-content-band flex w-full gap-[clamp(1.5rem,3vw,4rem)]",
|
|
74
75
|
...!showSidebar ? { "data-zd-nosidebar": "" } : {},
|
|
76
|
+
...contentWide ? { "data-zd-wide": "" } : {},
|
|
75
77
|
children: [
|
|
76
78
|
/* @__PURE__ */ jsxs("main", { class: "flex-1 min-w-0 px-hsp-xl py-vsp-xl lg:px-hsp-2xl lg:py-vsp-2xl", children: [
|
|
77
79
|
breadcrumb,
|
package/dist/features.css
CHANGED
|
@@ -335,6 +335,25 @@ pre[class^="syntect-"] .line .highlighted-word {
|
|
|
335
335
|
max-width: 80rem;
|
|
336
336
|
}
|
|
337
337
|
|
|
338
|
+
/* Wide band — opt-in full-width content layout (the `wide` frontmatter flag or
|
|
339
|
+
* the `contentWide` DocLayout prop set `data-zd-wide` on the band). Widens the
|
|
340
|
+
* reading column past the standard cap so grid-heavy / dashboard pages (e.g. the
|
|
341
|
+
* site home page) fill most of the viewport. Must beat BOTH capped variants:
|
|
342
|
+
* • the static hide_sidebar cap `.zd-doc-content-band[data-zd-nosidebar]`
|
|
343
|
+
* (specificity 0,2,0) — the first selector below is also 0,2,0 and wins by
|
|
344
|
+
* source order (it is placed after that rule);
|
|
345
|
+
* • the JS-toggle cap `html[data-sidebar-hidden] .zd-doc-content-band`
|
|
346
|
+
* (specificity 0,2,1) — the second selector below is 0,3,1 and wins on
|
|
347
|
+
* specificity.
|
|
348
|
+
* The literal clamp mirrors the established band-width pattern (see the
|
|
349
|
+
* `[data-zd-nosidebar]` 80rem literal and the `--zdc-content-max-width`
|
|
350
|
+
* default): fills up to ~92.5vw, floored at 50rem, capped at 120rem so
|
|
351
|
+
* ultra-wide monitors stay readable. Unlayered, so it beats Tailwind utilities. */
|
|
352
|
+
.zd-doc-content-band[data-zd-wide],
|
|
353
|
+
html[data-sidebar-hidden] .zd-doc-content-band[data-zd-wide] {
|
|
354
|
+
max-width: clamp(50rem, 92.5vw, 120rem);
|
|
355
|
+
}
|
|
356
|
+
|
|
338
357
|
/* Sidebar toggle button — left position uses CSS variable, needs global rule */
|
|
339
358
|
@media (min-width: 1024px) {
|
|
340
359
|
.zd-desktop-sidebar-toggle {
|
|
@@ -33,6 +33,14 @@ export interface HomePageViewProps {
|
|
|
33
33
|
/** Unique tag count for the current locale — gates the "all tags" section
|
|
34
34
|
* together with `settings.docTags`. */
|
|
35
35
|
tagCount: number;
|
|
36
|
+
/**
|
|
37
|
+
* Opt the home page into the **wide** content layout (full-viewport
|
|
38
|
+
* category grid instead of the standard capped reading column). Threaded to
|
|
39
|
+
* the underlying `DocLayoutWithDefaults` as `contentWide`. Defaults to
|
|
40
|
+
* `false` so downstream projects keep the narrower grid unless they opt in;
|
|
41
|
+
* this showcase passes `wide` from `pages/index.tsx`.
|
|
42
|
+
*/
|
|
43
|
+
wide?: boolean;
|
|
36
44
|
}
|
|
37
45
|
/**
|
|
38
46
|
* Create a `HomePageView` component from the unified {@link ChromeContext}
|
package/dist/home-page/index.js
CHANGED
|
@@ -25,7 +25,8 @@ function createHomePageView(ctx) {
|
|
|
25
25
|
extras,
|
|
26
26
|
tree,
|
|
27
27
|
categoryOrder,
|
|
28
|
-
tagCount
|
|
28
|
+
tagCount,
|
|
29
|
+
wide
|
|
29
30
|
}) {
|
|
30
31
|
const prefix = locale === defaultLocale ? "" : `/${locale}`;
|
|
31
32
|
const ctaNav = settings.headerNav[0] ?? null;
|
|
@@ -41,6 +42,7 @@ function createHomePageView(ctx) {
|
|
|
41
42
|
noindex: settings.noindex,
|
|
42
43
|
hideSidebar: true,
|
|
43
44
|
hideToc: true,
|
|
45
|
+
contentWide: wide,
|
|
44
46
|
sidebarOverride: /* @__PURE__ */ jsx(Fragment, {}),
|
|
45
47
|
headerOverride: /* @__PURE__ */ jsx(HeaderWithDefaults, { lang: locale, currentPath: withBase(`${prefix}/`) }),
|
|
46
48
|
footerOverride: /* @__PURE__ */ jsx(FooterWithDefaults, { lang: locale }),
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { mkdirSync, writeFileSync } from "node:fs";
|
|
2
|
+
import { dirname, resolve } from "node:path";
|
|
3
|
+
import { generateChangelogMarkdown } from "./generate.js";
|
|
4
|
+
import { loadChangelogEntries } from "./load.js";
|
|
5
|
+
function emitChangelogs(options) {
|
|
6
|
+
const written = [];
|
|
7
|
+
for (const config of options.changelogs) {
|
|
8
|
+
const sourceDir = resolve(options.projectRoot, config.sourceDir);
|
|
9
|
+
const outputFile = resolve(options.projectRoot, config.outputFile);
|
|
10
|
+
const entries = loadChangelogEntries({ sourceDir });
|
|
11
|
+
const markdown = generateChangelogMarkdown(entries, {
|
|
12
|
+
title: config.title,
|
|
13
|
+
packageName: config.packageName
|
|
14
|
+
});
|
|
15
|
+
mkdirSync(dirname(outputFile), { recursive: true });
|
|
16
|
+
writeFileSync(outputFile, markdown);
|
|
17
|
+
written.push(outputFile);
|
|
18
|
+
options.logger?.info(`Generated ${config.outputFile} (${entries.length} releases)`);
|
|
19
|
+
}
|
|
20
|
+
return { written };
|
|
21
|
+
}
|
|
22
|
+
export {
|
|
23
|
+
emitChangelogs
|
|
24
|
+
};
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
function generateChangelogMarkdown(entries, options = {}) {
|
|
2
|
+
const title = options.title ?? "Changelog";
|
|
3
|
+
const lines = [`# ${title}`, ""];
|
|
4
|
+
if (options.packageName) {
|
|
5
|
+
lines.push(`All notable changes to \`${options.packageName}\` are documented in this file.`);
|
|
6
|
+
} else {
|
|
7
|
+
lines.push("All notable changes to this project are documented in this file.");
|
|
8
|
+
}
|
|
9
|
+
lines.push("");
|
|
10
|
+
lines.push("The format is based on Keep a Changelog, and release notes are generated from the changelog MDX pages.");
|
|
11
|
+
for (const entry of entries) {
|
|
12
|
+
lines.push("");
|
|
13
|
+
lines.push(entry.date ? `## [${entry.version}] - ${entry.date}` : `## [${entry.version}]`);
|
|
14
|
+
if (entry.content) {
|
|
15
|
+
lines.push("");
|
|
16
|
+
lines.push(entry.content);
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
lines.push("");
|
|
20
|
+
return lines.join("\n");
|
|
21
|
+
}
|
|
22
|
+
export {
|
|
23
|
+
generateChangelogMarkdown
|
|
24
|
+
};
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
export { emitChangelogs } from "./emit.js";
|
|
2
|
+
export { generateChangelogMarkdown } from "./generate.js";
|
|
3
|
+
export { compareEntriesNewestFirst, loadChangelogEntries } from "./load.js";
|
|
4
|
+
export { sanitizeChangelogMarkdown } from "./sanitize.js";
|
|
5
|
+
export type { ChangelogConfig, ChangelogEmitOptions, ChangelogEmitResult, ChangelogEntry, ChangelogGenerateOptions, ChangelogLoadOptions, ChangelogLogger, } from "./types.js";
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { emitChangelogs } from "./emit.js";
|
|
2
|
+
import { generateChangelogMarkdown } from "./generate.js";
|
|
3
|
+
import { compareEntriesNewestFirst, loadChangelogEntries } from "./load.js";
|
|
4
|
+
import { sanitizeChangelogMarkdown } from "./sanitize.js";
|
|
5
|
+
export {
|
|
6
|
+
compareEntriesNewestFirst,
|
|
7
|
+
emitChangelogs,
|
|
8
|
+
generateChangelogMarkdown,
|
|
9
|
+
loadChangelogEntries,
|
|
10
|
+
sanitizeChangelogMarkdown
|
|
11
|
+
};
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
import { readdirSync } from "node:fs";
|
|
2
|
+
import { basename, join, resolve } from "node:path";
|
|
3
|
+
import { parseMarkdownFile } from "../../md-utils/index.js";
|
|
4
|
+
import { sanitizeChangelogMarkdown } from "./sanitize.js";
|
|
5
|
+
const RELEASED_RE = /^Released:\s*(\d{4}-\d{2}-\d{2})\s*$/im;
|
|
6
|
+
function loadChangelogEntries(options) {
|
|
7
|
+
const absDir = resolve(options.sourceDir);
|
|
8
|
+
const names = readdirSync(absDir);
|
|
9
|
+
const entries = [];
|
|
10
|
+
for (const name of names) {
|
|
11
|
+
if (!/\.mdx?$/.test(name) || name === "index.mdx" || name === "index.md" || name.startsWith("_")) {
|
|
12
|
+
continue;
|
|
13
|
+
}
|
|
14
|
+
const sourcePath = join(absDir, name);
|
|
15
|
+
const parsed = parseMarkdownFile(sourcePath);
|
|
16
|
+
if (!parsed) continue;
|
|
17
|
+
const version = String(parsed.data.title ?? basename(name).replace(/\.mdx?$/, ""));
|
|
18
|
+
const rawContent = parsed.content;
|
|
19
|
+
const date = rawContent.match(RELEASED_RE)?.[1];
|
|
20
|
+
const contentWithoutReleased = rawContent.replace(RELEASED_RE, "").trim();
|
|
21
|
+
const content = sanitizeChangelogMarkdown(contentWithoutReleased);
|
|
22
|
+
entries.push({ version, date, content, sourcePath });
|
|
23
|
+
}
|
|
24
|
+
entries.sort(compareEntriesNewestFirst);
|
|
25
|
+
return entries;
|
|
26
|
+
}
|
|
27
|
+
function compareEntriesNewestFirst(a, b) {
|
|
28
|
+
const byVersion = compareSemverLike(b.version, a.version);
|
|
29
|
+
if (byVersion !== 0) return byVersion;
|
|
30
|
+
return b.sourcePath.localeCompare(a.sourcePath);
|
|
31
|
+
}
|
|
32
|
+
function compareSemverLike(a, b) {
|
|
33
|
+
const parsedA = parseSemverLike(a);
|
|
34
|
+
const parsedB = parseSemverLike(b);
|
|
35
|
+
if (!parsedA || !parsedB) return a.localeCompare(b, void 0, { numeric: true });
|
|
36
|
+
for (const key of ["major", "minor", "patch"]) {
|
|
37
|
+
const diff = parsedA[key] - parsedB[key];
|
|
38
|
+
if (diff !== 0) return diff;
|
|
39
|
+
}
|
|
40
|
+
if (!parsedA.pre && !parsedB.pre) return 0;
|
|
41
|
+
if (!parsedA.pre) return 1;
|
|
42
|
+
if (!parsedB.pre) return -1;
|
|
43
|
+
return comparePrerelease(parsedA.pre, parsedB.pre);
|
|
44
|
+
}
|
|
45
|
+
function parseSemverLike(version) {
|
|
46
|
+
const match = version.trim().match(/^v?(\d+)\.(\d+)\.(\d+)(?:-([0-9A-Za-z.-]+))?/);
|
|
47
|
+
if (!match) return null;
|
|
48
|
+
return {
|
|
49
|
+
major: Number(match[1]),
|
|
50
|
+
minor: Number(match[2]),
|
|
51
|
+
patch: Number(match[3]),
|
|
52
|
+
pre: match[4] ? match[4].split(".") : null
|
|
53
|
+
};
|
|
54
|
+
}
|
|
55
|
+
function comparePrerelease(a, b) {
|
|
56
|
+
const len = Math.max(a.length, b.length);
|
|
57
|
+
for (let i = 0; i < len; i += 1) {
|
|
58
|
+
const left = a[i];
|
|
59
|
+
const right = b[i];
|
|
60
|
+
if (left === void 0) return -1;
|
|
61
|
+
if (right === void 0) return 1;
|
|
62
|
+
const leftNum = /^\d+$/.test(left) ? Number(left) : null;
|
|
63
|
+
const rightNum = /^\d+$/.test(right) ? Number(right) : null;
|
|
64
|
+
if (leftNum !== null && rightNum !== null) {
|
|
65
|
+
const diff2 = leftNum - rightNum;
|
|
66
|
+
if (diff2 !== 0) return diff2;
|
|
67
|
+
continue;
|
|
68
|
+
}
|
|
69
|
+
if (leftNum !== null) return -1;
|
|
70
|
+
if (rightNum !== null) return 1;
|
|
71
|
+
const diff = left.localeCompare(right);
|
|
72
|
+
if (diff !== 0) return diff;
|
|
73
|
+
}
|
|
74
|
+
return 0;
|
|
75
|
+
}
|
|
76
|
+
export {
|
|
77
|
+
compareEntriesNewestFirst,
|
|
78
|
+
loadChangelogEntries
|
|
79
|
+
};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Convert authored MDX-ish changelog body content into package-safe
|
|
3
|
+
* CommonMark. This deliberately handles the MDX constructs that should not
|
|
4
|
+
* leak into `node_modules/CHANGELOG.md` while preserving normal markdown.
|
|
5
|
+
*
|
|
6
|
+
* Fenced code blocks are protected from these transforms first - a changelog
|
|
7
|
+
* entry documenting a code change can legitimately contain `import`/`export`/
|
|
8
|
+
* JSX syntax inside an example, and that must survive verbatim.
|
|
9
|
+
*/
|
|
10
|
+
export declare function sanitizeChangelogMarkdown(content: string): string;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
const FENCED_CODE_BLOCK_RE = /^([ \t]*```[^\n]*\n[\s\S]*?\n[ \t]*```[ \t]*)$/gm;
|
|
2
|
+
function sanitizeChangelogMarkdown(content) {
|
|
3
|
+
const codeBlocks = [];
|
|
4
|
+
const withPlaceholders = content.replace(FENCED_CODE_BLOCK_RE, (match) => {
|
|
5
|
+
const token = `CHANGELOG_CODE_BLOCK_PLACEHOLDER_${codeBlocks.length}`;
|
|
6
|
+
codeBlocks.push(match);
|
|
7
|
+
return token;
|
|
8
|
+
});
|
|
9
|
+
const sanitized = withPlaceholders.replace(/^import\s+.*$/gm, "").replace(/^export\s+.*$/gm, "").replace(/\{\/\*[\s\S]*?\*\/\}/g, "").replace(/^:::\s*([A-Za-z][\w-]*).*$/gm, (_m, name) => {
|
|
10
|
+
return `> **${labelize(name)}**`;
|
|
11
|
+
}).replace(/^:::\s*$/gm, "").replace(/^<([A-Z][A-Za-z0-9]*)\b[^>]*>\s*$/gm, (_m, name) => {
|
|
12
|
+
return `> **${labelize(name)}**`;
|
|
13
|
+
}).replace(/^<\/[A-Z][A-Za-z0-9]*>\s*$/gm, "").replace(/<\/?[A-Z][A-Za-z0-9]*\b[^>]*>/g, "").replace(/\n{3,}/g, "\n\n").trim();
|
|
14
|
+
return codeBlocks.reduce(
|
|
15
|
+
(acc, block, i) => acc.replace(`CHANGELOG_CODE_BLOCK_PLACEHOLDER_${i}`, () => block),
|
|
16
|
+
sanitized
|
|
17
|
+
).trim();
|
|
18
|
+
}
|
|
19
|
+
function labelize(name) {
|
|
20
|
+
return name.replace(/[-_]+/g, " ").replace(/([a-z0-9])([A-Z])/g, "$1 $2").replace(/\b\w/g, (ch) => ch.toUpperCase());
|
|
21
|
+
}
|
|
22
|
+
export {
|
|
23
|
+
sanitizeChangelogMarkdown
|
|
24
|
+
};
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
export interface ChangelogConfig {
|
|
2
|
+
sourceDir: string;
|
|
3
|
+
outputFile: string;
|
|
4
|
+
packageName?: string;
|
|
5
|
+
title?: string;
|
|
6
|
+
}
|
|
7
|
+
export interface ChangelogEmitOptions {
|
|
8
|
+
projectRoot: string;
|
|
9
|
+
changelogs: readonly ChangelogConfig[];
|
|
10
|
+
logger?: ChangelogLogger;
|
|
11
|
+
}
|
|
12
|
+
export interface ChangelogEmitResult {
|
|
13
|
+
written: string[];
|
|
14
|
+
}
|
|
15
|
+
export interface ChangelogLogger {
|
|
16
|
+
info(message: string): void;
|
|
17
|
+
warn?(message: string): void;
|
|
18
|
+
}
|
|
19
|
+
export interface ChangelogEntry {
|
|
20
|
+
version: string;
|
|
21
|
+
date?: string;
|
|
22
|
+
content: string;
|
|
23
|
+
sourcePath: string;
|
|
24
|
+
}
|
|
25
|
+
export interface ChangelogLoadOptions {
|
|
26
|
+
sourceDir: string;
|
|
27
|
+
}
|
|
28
|
+
export interface ChangelogGenerateOptions {
|
|
29
|
+
title?: string;
|
|
30
|
+
packageName?: string;
|
|
31
|
+
}
|
|
File without changes
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { emitChangelogs } from "../integrations/changelog/index.js";
|
|
2
|
+
const plugin = {
|
|
3
|
+
name: "changelog",
|
|
4
|
+
async postBuild(ctx) {
|
|
5
|
+
const changelogs = ctx.options["changelogs"];
|
|
6
|
+
if (!Array.isArray(changelogs) || changelogs.length === 0) return;
|
|
7
|
+
emitChangelogs({
|
|
8
|
+
projectRoot: ctx.projectRoot,
|
|
9
|
+
changelogs,
|
|
10
|
+
logger: ctx.logger
|
|
11
|
+
});
|
|
12
|
+
}
|
|
13
|
+
};
|
|
14
|
+
var changelog_default = plugin;
|
|
15
|
+
export {
|
|
16
|
+
changelog_default as default
|
|
17
|
+
};
|
package/dist/preset.d.ts
CHANGED
|
@@ -56,6 +56,12 @@ export interface PresetClaudeResourcesConfig {
|
|
|
56
56
|
*/
|
|
57
57
|
scanRoot?: string;
|
|
58
58
|
}
|
|
59
|
+
export interface PresetChangelogConfig {
|
|
60
|
+
sourceDir: string;
|
|
61
|
+
outputFile: string;
|
|
62
|
+
packageName?: string;
|
|
63
|
+
title?: string;
|
|
64
|
+
}
|
|
59
65
|
/**
|
|
60
66
|
* The subset of `settings` the preset reads. Any concrete `typeof settings`
|
|
61
67
|
* (this repo's or a generated project's) is assignable to this — the preset
|
|
@@ -74,6 +80,7 @@ export interface PresetSettings {
|
|
|
74
80
|
onBrokenMarkdownLinks: "warn" | "error" | "ignore";
|
|
75
81
|
headingIdStrategy: "flat" | "hierarchical";
|
|
76
82
|
llmsTxt?: boolean;
|
|
83
|
+
changelogs?: PresetChangelogConfig[] | false;
|
|
77
84
|
docHistory?: boolean;
|
|
78
85
|
claudeResources?: PresetClaudeResourcesConfig | false;
|
|
79
86
|
/** "owner/repo" — when set, enables `#123` / SHA autolinks in markdown. Omit to disable entirely. */
|
package/dist/preset.js
CHANGED
|
@@ -206,6 +206,14 @@ function buildPlugins(settings, routeContext) {
|
|
|
206
206
|
locales: localeArray
|
|
207
207
|
}
|
|
208
208
|
}
|
|
209
|
+
] : [],
|
|
210
|
+
...Array.isArray(settings.changelogs) && settings.changelogs.length > 0 ? [
|
|
211
|
+
{
|
|
212
|
+
name: "@takazudo/zudo-doc/plugins/changelog",
|
|
213
|
+
options: {
|
|
214
|
+
changelogs: settings.changelogs.map((changelog) => ({ ...changelog }))
|
|
215
|
+
}
|
|
216
|
+
}
|
|
209
217
|
] : []
|
|
210
218
|
];
|
|
211
219
|
}
|
package/dist/safelist.css
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
/* generated by gen-safelist.mjs — do not edit by hand */
|
|
2
|
-
@source inline("-link -mb-px -ml-hsp-sm -noscript -open -translate-x-full 2xl:w-[24px] [&::-webkit-details-marker]:hidden [&_a]:text-accent [&_a]:underline [&_nav]:mb-0 [data-admonition] [data-kbd-shortcut] [doc-history-meta] [doc-history] [doc-layout] [llms-txt] [zudo-doc] a a2 abbr about above absent absolute accent accent:accent- across activated active actual added admonition admonition- admonition-body admonition-title admonition/callout after after-breadcrumb after-content after-navigate after-sidebar after-title against agent agents ai-chat ai-chat-md ai-chat-trigger alert align-top all allow-same-origin allow-scripts alone already already-executed already-picked an anchor anchored and and/or animate-spin announce antialiased any application/json application/xml applies apply-css-vars approach are area arg aria-atomic aria-busy aria-controls aria-current aria-disabled aria-expanded aria-haspopup aria-hidden aria-label aria-live aria-orientation aria-pressed aria-selected aria-valuemax aria-valuemin aria-valuenow arm arms array arrows article as asc aside aspect-[1200/630] aspect-square asset- assets assistant async at attach attribute attributes auto autogenerated available avoid await away b back backdrop:bg-bg/30 backdrop:bg-bg/80 backdrop:bg-overlay/60 backdrop:z-modal-backdrop background background-color backtick backticks baked banner bare base base64 base:base- based baseline batch be because before below best between bg bg-[#fff] bg-accent bg-bg bg-chat-assistant-bg bg-chat-user-bg bg-code-bg bg-fg bg-info/10 bg-info/5 bg-muted bg-overlay/30 bg-surface bg-transparent bg-warning/10 bg-warning/5 bi bigint bin blank blanks blob block blockquote blocks blur body body-end-components body-end-scripts bold boolean bootstrap border border-accent border-b border-b-2 border-b-[5px] border-bg/30 border-collapse border-danger border-dashed border-fg border-info/30 border-l border-l-0 border-l-[3px] border-left-width border-muted border-none border-r border-radius border-solid border-t border-t-[2px] border-t-[3px] border-transparent border-warning/30 border-width border-y both bottom-vsp-xl box-border br brand breadcrumb:end breadcrumb:start break-words browser browsers btn bug build bundler but button buttons by bypassed byte-identical bytes cached call caller calls can cancellation cannot canonical canvas caption card card-grid carry cases cat-nav- catch category catppuccin-latte caught caution center center/contain ch chains change changed changes checkbox child chrome ci circle cite class class-less claude claude-agents claude-commands claude-md claude-skills cleaned clear clear-css-vars clearing click client client-router client-side clip clobbering close closed closing code code-block-sr-announce code-group code-group-panel col col-resize colgroup collision color color-scheme color-scheme-changed color-scheme-provider color-tweak colorization colors column comma command commands comment commit compare component component:github-link component:language-switcher component:search component:theme-toggle component:version-switcher compute computed concrete configuration configure configured confuse connect const construction consumer consumes container containers containing content content-admonition content-link content-type content-wrapper:end content-wrapper:start contents context controller controls converts copy corners correct correctly corrupt count covered covers cp crashes created cross-component crumb- cs css ctx cur current cursor-not-allowed cursor-pointer custom danger dark data data-active data-admonition data-base data-close-search data-current-locale data-default-locale data-group-id data-header data-header-logo data-header-nav data-header-right data-kbd-shortcut data-language-switcher data-loading-index data-mermaid-enlarge-ready data-mermaid-rendered data-mermaid-src data-nav-active data-nav-item data-nav-item-dropdown data-nav-more data-nav-more-menu data-nav-more-toggle data-no-results data-open-search data-pan-active data-processed data-result-count-template data-search-count data-search-count-narrow data-search-dialog data-search-input data-search-placeholder data-search-results data-search-unavailable data-sidebar-hidden data-sidebar-resizer data-site-nav data-tab-btn data-tab-default data-tab-label data-tab-value data-tabs data-taglist-group data-testid data-theme data-theme/style data-trailing-slash data-variant data-version-banner data-version-latest data-version-menu data-version-rewire data-version-slug data-version-switcher data-version-toggle data-version-trigger-label data-zd-nosidebar data-zd-toc data-zfb-transition-persist dd decimal declare decoration decoration-muted default defaults del delegated dependency depth desc description design design-token design-token-panel design-token-trigger desktop desktop-sidebar desktop-sidebar-toggle desktop-sidebar-toggle-island destructive detach detached details detected deterministic develop dfn diagram diagrams dialog dieser diff diff-line-added diff-line-content diff-line-empty diff-line-num diff-line-removed diff-row dir directly directories directory disabled disabled:opacity-50 disc display:none dist distinct div dl do doc doc-card- doc-content-band doc-history doc-history-generate doc-history-panel doc-history-trigger doc-page doc-pager doc-prose doc-title docs docs- docs-v- document document-level documented does double-registration drag draggable drop dropdown dropdown-child dropdown-parent dropdowns dt duration-150 duration-200 during dynamically e2e each ease-in-out edge eject ejected el element elements els else em embedded emit emitting empty empty/undefined en enable end enlarged entire entities entries entry error escape escaped even eventually every exactly excerpt excludes existing exists exit expected export extends factories failed faithful fall fallback fallbacks falls false family fast feature feed fg fields fieldset figcaption figure file fill fills finally find fire fires first fixed fixed-width fixtures flag flash flat flex flex-1 flex-col flex-wrap flip flipping flips flush-left focus focus-visible:outline-2 focus-visible:outline-accent focus-visible:outline-offset-2 focus-visible:underline focus:border-accent focus:outline-none focus:underline font font-bold font-family font-medium font-mono font-semibold font-weight footer footer- for form found free fresh from frontmatter frontmatter-preview frozen fs-extra full fully function further g gap-[0.3em] gap-[clamp(1.5rem,3vw,4rem)] gap-hsp-2xs gap-hsp-md gap-hsp-sm gap-hsp-xl gap-hsp-xs gap-vsp-2xs gap-vsp-lg gap-vsp-md gap-vsp-xs gap-x-hsp-2xs gap-x-hsp-lg gap-x-hsp-md gap-x-hsp-sm gap-x-hsp-xs gap-y-vsp-2xs gap-y-vsp-lg gap-y-vsp-md gap-y-vsp-xs gaps gate generate generation genuine geometry get github github-link go got graph gray-matter grid grid-cols-1 grid-cols-2 group group-focus-visible:text-accent group-focus-visible:underline group-focus-within:block group-hover:bg-fg group-hover:block group-hover:text-accent group-hover:text-bg group-hover:underline group-open:rotate-90 guard h-[0.5rem] h-[0.625rem] h-[0.875rem] h-[1.125rem] h-[1.25rem] h-[1.575rem] h-[14px] h-[1em] h-[1lh] h-[2rem] h-[3.5rem] h-[3rem] h-[90vh] h-[calc(100%-3rem)] h-[calc(100vh-3.5rem)] h-dvh h-full h-icon-lg h-icon-md h-icon-sm h-icon-xs h1 h1s h2 h2s h3 h4 h5 h6 half hand hand-copied handle handled handler handlers has hash-link have head head-links head-scripts header header- header-call:end header-call:start heading heading-h2 heading-h3 heading-h4 headings height here hex hidden highlight highlighter history hit horizontal host hover:bg-[color-mix(in_srgb,var(--color-surface)_80%,var(--color-fg)_20%)] hover:bg-accent-hover hover:bg-accent/10 hover:bg-surface hover:border-accent hover:border-accent-hover hover:border-fg hover:text-accent hover:text-accent-hover hover:text-fg hover:underline hr href hrefs html i i18n/theme. i2 i3 i4 icon identical idle idx if iframe image image-enlarge image/png img implementation import important imports in inactive inbox includes index info inherit inherited initial initialised injected inline inline-block inline-flex inner input input-clear ins inset-0 inside install instance instanceof instead instructions intended intent into invalid inverse inversion invoke is issues it italic item item- items items-baseline items-center items-start its itself javascript justify-between justify-center justify-end justify-start katex kbd keep keeps kept keyboard keyboard-shortcut keydown keystroke keywords khroma label landing language-switcher last:border-b-0 later launch layout leading-relaxed leading-snug leading-tight leaf- leak leaves left left-0 left:calc legend legitimate letter-spacing lg lg:block lg:border lg:border-fg lg:border-solid lg:flex lg:flex-col lg:flex-row lg:gap-hsp-xl lg:grid-cols-[repeat(auto-fit,minmax(12rem,1fr))] lg:h-[90vh] lg:hidden lg:justify-start lg:m-auto lg:max-h-[90vh] lg:max-w-[52.5rem] lg:ml-[var(--zd-sidebar-w)] lg:pt-vsp-2xl lg:px-hsp-2xl lg:py-vsp-2xl lg:text-left lg:w-[90vw] lg:w-[clamp(16rem,25%,22rem)] li li2 library light like likely line linger link link- links list-disc list-none listener literal literals lives llms llms-txt load local locale locales log longest-match look lostpointercapture lower luminance m m-0 m21 m6 main make malformed malicious maps mark marks matches matching math math-display math-inline max max-h-[80vh] max-h-[85vh] max-h-[90vh] max-h-full max-h-none max-w-[46rem] max-w-[85%] max-w-[85vw] max-w-[90vw] max-w-[clamp(50rem,75vw,90rem)] max-w-full max-w-none max-width may mb-0 mb-vsp-2xs mb-vsp-lg mb-vsp-md mb-vsp-sm mb-vsp-xl mb-vsp-xs measures measuring mechanism menu merged mermaid message messages meta meta-knob metadata migration min-h-[60vh] min-h-[calc(100vh-3.5rem)] min-h-screen min-w-0 min-w-[10rem] min-w-[8rem] mirror mirrors missing ml-auto ml-hsp-2xl ml-hsp-lg ml-hsp-sm ml-hsp-xl mod mode module mounted mouseenter mouseleave mr-hsp-sm mt-0 mt-vsp-2xl mt-vsp-2xs mt-vsp-3xs mt-vsp-lg mt-vsp-md mt-vsp-sm mt-vsp-xl must mutates mutation mutations muted mx-auto my-vsp-lg my-vsp-md name named native nav nav-active nav-card- nav/doc navigating navigation navigations near needs nested new newly-swapped next no no-enlarge no-op no-repeat no-underline node node:buffer node:fs node:fs/promises node:module node:path nodes nofollow noindex non-empty non-light-dark non-persisted none noopener noreferrer normal noscript not not-object note now null number numeric object object-contain observe observer occurred of off og:description og:image og:image:alt og:image:height og:image:width og:title og:type og:url oklch ol old older on once one only onto opacity-60 open open/close option or original other others out outline-none over overflow overflow-auto overflow-hidden overflow-x-auto overflow-y-auto overflow-y:auto overwrite own p p-0 p-hsp-lg p-hsp-md p-hsp-sm p-hsp-xl package package-owned packages padding page page-loading page-loading-overlay page-loading-spinner page-navigate-end page-title pages pages/. paint paint-and-read palette pan panel panels paren-balance-aware parent parse parsed pass passed passes path paths pattern pb-[50vh] pb-vsp-md pb-vsp-xl pb-vsp-xs per per-link permanently persisted pi pick picked picks picocolors pins pipelines pl-[1.25rem] pl-hsp-lg pl-hsp-sm pl-hsp-xl place placeholder placeholder:text-muted plain plural plus pnpm pointer-events-none pointercancel pointerdown pointermove pointerup polite polygon polyline populates port position position:fixed pr-[4px] pr-hsp-lg pr-hsp-md pr-hsp-sm pr-hsp-xl pre pre-lowercased preact preact/compat preact/hooks preact/jsx-runtime preconnect prefix preload pres preserving print produce produced produces production project project-root-relative properties property props prose provided proxy pt-[0.15rem] pt-[2px] pt-vsp-3xs pt-vsp-md pt-vsp-sm pt-vsp-xl pt-vsp-xs ptag- public purely px px-hsp-2xl px-hsp-2xs px-hsp-lg px-hsp-md px-hsp-sm px-hsp-xl px-hsp-xs py-0 py-[2px] py-[calc(var(--spacing-vsp-xs)+0.15rem)] py-hsp-2xs py-hsp-sm py-hsp-xs py-vsp-2xs py-vsp-3xs py-vsp-lg py-vsp-md py-vsp-sm py-vsp-xl py-vsp-xs q query question r radius ramp range raw re-encode/decode re-querying re-render re-renders re-run re-running re-selects reach reached reaches read reading ready real real-value received receives recorded recovers redefine ref- references refetch refreshes regenerate regenerates regex reinit reinits relative reload relying remove removed render rendered renders reorder repaint repeated repeating replaced replaces repopulate requires reserved reset resize resize-x resolve resolved resolves response restore restores result result-click results results-area retry return returns revision revisions rewrite right right- right-0 ro robots role roles root rotate-180 rotate-90 round round-trip rounded rounded-[0.75rem] rounded-bl-[0.25rem] rounded-bl-[1rem] rounded-br-[0.25rem] rounded-br-[1rem] rounded-full rounded-lg rounded-t-[1rem] rounds route router routes routes-src running runs runtime s safe safer same same-locale samp scale scanned schema-mismatch schema-missing scheme scored script script- script-eval script-evaluation script-injection scripts scroll scrollbar scrolled scrollend search search-index section section- see select select-none selection-bg selection-fg self self-start semibold sentinel separator serialised serialize server server-rendered set sets setting setup shadow-[0_1px_3px_color-mix(in_srgb,var(--color-fg)_8%,transparent)] shadow-lg shape share shared sharing shiki ship shipped ships short shortcut should show shown shrink-0 sidebar sidebar- sidebar-toggle-island sidebar-tree-island signal similarity single singular site-search site-tree-nav-island sitemap- sites size skill skills skipping skips slash slug sm:border sm:border-muted sm:flex-row sm:grid-cols-2 sm:h-auto sm:items-center sm:justify-between sm:max-h-[80vh] sm:max-w-[52rem] sm:mx-auto sm:my-[10vh] sm:rounded-lg small smooth snapshot snapshots so soft soft-nav solid some somehow source sources space-y-vsp-2xs spacing span spans spec specifier specifiers splitter square sr-only src stale start state state:state- status stay staying sticky still stop stored stray string strings strip stripe stroke-linecap stroke-linejoin stroke-width strong stronger style style-attribute styled styles stylesheet sub subagents subsequent success successful summary sup surface surfaces survives svg swap swapped swaps synchronous synchronously syntactically syntect t tab tab-item tab-panel tabindex table tablist tabpanel tabs tabs-container tabs-content tabs-nav tag tag- tag-item- tags tags:audit take tbody td temp-element template temporary temporary-element terminal terms test-results tested text text-accent text-bg text-body text-caption text-center text-chat-assistant-text text-chat-user-text text-code-fg text-danger text-decoration text-display text-fg text-heading text-info text-left text-micro text-muted text-muted/50 text-right text-small text-title text-warning text/plain textarea tfoot th that the thead their them theme theme-color theme-toggle theme/token then there these they this through throw tighten time tip title to toc toggle toggle-ai-chat toggle-design-token-panel toggles token tokens tolerates too toolbar top-0 top-[3.5rem] top-full top-level total touches tp tr tracked tracking-wider trade-off transition transition-[background,color,border-color] transition-[left,color] transition-colors transition-transform translate-x-0 translations transparent treats tree tree-child- tree-item- tree-top- trigger trigger:ai-chat trigger:design-token-panel triggers true truncate truncated try turn twitter:card twitter:creator twitter:description twitter:image twitter:site twitter:title two type typography u ul unavailable unchanged undefined under underline underlines understand unit-tested unknown unmaintained unobserve unreadable unrelated unreleased unset up uppercase usage use used user uses utf-8 utf8 utilities utility v v1 v2 val valid value value-reader values var variable variant verbatim version version- version-menu version-switcher vertical via video viewport virtual:zudo-doc-chrome-bindings virtual:zudo-doc-route-context visible vitesse-dark vocabulary w w-1/2 w-[0.5rem] w-[0.625rem] w-[0.875rem] w-[1.125rem] w-[1.575rem] w-[1.5rem] w-[1.75rem] w-[14px] w-[16px] w-[16rem] w-[18px] w-[1em] w-[280px] w-[2rem] w-[320px] w-[90vw] w-[var(--zd-sidebar-w)] w-dvw w-full w-icon-lg w-icon-md w-icon-sm w-icon-xs want warning was watching wbr wbr- we website weight went were what when where whereas whether which while whitespace-nowrap whitespace-pre whole wide-gamut width will with without word working worktrees would wrap wrapper wrappers written wrong wrote xl:flex xl:hidden y-scrollbar yet you your z-dropdown z-local-1 z-modal z-modal-backdrop z-sidebar z-toolbar zd-content zd-desktop-sidebar-toggle zd-doc-content-band zd-enlarge-btn zd-enlarge-dialog zd-enlarge-dialog-close zd-enlargeable zd-html-preview-code zd-mermaid-dialog zd-mermaid-enlargeable zd-mermaid-tool-btn zd-mermaid-toolbar zd-mermaid-transform zd-mermaid-viewport zd-sidebar-content-wrapper zd-sidebar-open zfb zfb:after-swap zfb:before-preparation zod zoom zudo-doc-design-tokens/v1 zudo-doc-design-tokens/v2 zudo-doc-design-tokens/v3 zudo-doc-sidebar-visible zudo-doc-sidebar-width zudo-doc-theme zudo-doc-theme-bridge");
|
|
2
|
+
@source inline("-link -mb-px -ml-hsp-sm -noscript -open -translate-x-full 2xl:w-[24px] [&::-webkit-details-marker]:hidden [&_a]:text-accent [&_a]:underline [&_nav]:mb-0 [data-admonition] [data-kbd-shortcut] [doc-history-meta] [doc-history] [doc-layout] [llms-txt] [zudo-doc] a a2 abbr about above absent absolute accent accent:accent- across activated active actual added admonition admonition- admonition-body admonition-title admonition/callout after after-breadcrumb after-content after-navigate after-sidebar after-title against agent agents ai-chat ai-chat-md ai-chat-trigger alert align-top all allow-same-origin allow-scripts alone already already-executed already-picked an anchor anchored and and/or animate-spin announce antialiased any application/json application/xml applies apply-css-vars approach are area arg aria-atomic aria-busy aria-controls aria-current aria-disabled aria-expanded aria-haspopup aria-hidden aria-label aria-live aria-orientation aria-pressed aria-selected aria-valuemax aria-valuemin aria-valuenow arm arms array arrows article as asc aside aspect-[1200/630] aspect-square asset- assets assistant async at attach attribute attributes auto autogenerated available avoid await away b back backdrop:bg-bg/30 backdrop:bg-bg/80 backdrop:bg-overlay/60 backdrop:z-modal-backdrop background background-color backtick backticks baked banner bare base base64 base:base- based baseline batch be because before below best between bg bg-[#fff] bg-accent bg-bg bg-chat-assistant-bg bg-chat-user-bg bg-code-bg bg-fg bg-info/10 bg-info/5 bg-muted bg-overlay/30 bg-surface bg-transparent bg-warning/10 bg-warning/5 bi bigint bin blank blanks blob block blockquote blocks blur body body-end-components body-end-scripts bold boolean bootstrap border border-accent border-b border-b-2 border-b-[5px] border-bg/30 border-collapse border-danger border-dashed border-fg border-info/30 border-l border-l-0 border-l-[3px] border-left-width border-muted border-none border-r border-radius border-solid border-t border-t-[2px] border-t-[3px] border-transparent border-warning/30 border-width border-y both bottom-vsp-xl box-border br brand breadcrumb:end breadcrumb:start break-words browser browsers btn bug build bundler but button buttons by bypassed byte-identical bytes cached call caller calls can cancellation cannot canonical canvas caption card card-grid carry cases cat-nav- catch category catppuccin-latte caught caution center center/contain ch chains change changed changelog changelogs changes checkbox child chrome ci circle cite class class-less claude claude-agents claude-commands claude-md claude-skills cleaned clear clear-css-vars clearing click client client-router client-side clip clobbering close closed closing code code-block-sr-announce code-group code-group-panel col col-resize colgroup collision color color-scheme color-scheme-changed color-scheme-provider color-tweak colorization colors column comma command commands comment commit compare component component:github-link component:language-switcher component:search component:theme-toggle component:version-switcher compute computed concrete configuration configure configured confuse connect const construction consumer consumes container containers containing content content-admonition content-link content-type content-wrapper:end content-wrapper:start contents context controller controls converts copy corners correct correctly corrupt count covered covers cp crashes created cross-component crumb- cs css ctx cur current cursor-not-allowed cursor-pointer custom danger dark data data-active data-admonition data-base data-close-search data-current-locale data-default-locale data-group-id data-header data-header-logo data-header-nav data-header-right data-kbd-shortcut data-language-switcher data-loading-index data-mermaid-enlarge-ready data-mermaid-rendered data-mermaid-src data-nav-active data-nav-item data-nav-item-dropdown data-nav-more data-nav-more-menu data-nav-more-toggle data-no-results data-open-search data-pan-active data-processed data-result-count-template data-search-count data-search-count-narrow data-search-dialog data-search-input data-search-placeholder data-search-results data-search-unavailable data-sidebar-hidden data-sidebar-resizer data-site-nav data-tab-btn data-tab-default data-tab-label data-tab-value data-tabs data-taglist-group data-testid data-theme data-theme/style data-trailing-slash data-variant data-version-banner data-version-latest data-version-menu data-version-rewire data-version-slug data-version-switcher data-version-toggle data-version-trigger-label data-zd-nosidebar data-zd-toc data-zd-wide data-zfb-transition-persist dd decimal declare decoration decoration-muted default defaults del delegated dependency depth desc description design design-token design-token-panel design-token-trigger desktop desktop-sidebar desktop-sidebar-toggle desktop-sidebar-toggle-island destructive detach detached details detected deterministic develop dfn diagram diagrams dialog dieser diff diff-line-added diff-line-content diff-line-empty diff-line-num diff-line-removed diff-row dir directly directories directory disabled disabled:opacity-50 disc display:none dist distinct div dl do doc doc-card- doc-content-band doc-history doc-history-generate doc-history-panel doc-history-trigger doc-page doc-pager doc-prose doc-title docs docs- docs-v- document document-level documented does double-registration drag draggable drop dropdown dropdown-child dropdown-parent dropdowns dt duration-150 duration-200 during dynamically e2e each ease-in-out edge eject ejected el element elements els else em embedded emit emitting empty empty/undefined en enable end enlarged entire entities entries entry error escape escaped even eventually every exactly excerpt excludes existing exists exit expected export extends factories failed faithful fall fallback fallbacks falls false family fast feature feed fg fields fieldset figcaption figure file fill fills finally find fire fires first fixed fixed-width fixtures flag flash flat flex flex-1 flex-col flex-wrap flip flipping flips flush-left focus focus-visible:outline-2 focus-visible:outline-accent focus-visible:outline-offset-2 focus-visible:underline focus:border-accent focus:outline-none focus:underline font font-bold font-family font-medium font-mono font-semibold font-weight footer footer- for form format found free fresh from frontmatter frontmatter-preview frozen fs-extra full fully function further g gap-[0.3em] gap-[clamp(1.5rem,3vw,4rem)] gap-hsp-2xs gap-hsp-md gap-hsp-sm gap-hsp-xl gap-hsp-xs gap-vsp-2xs gap-vsp-lg gap-vsp-md gap-vsp-xs gap-x-hsp-2xs gap-x-hsp-lg gap-x-hsp-md gap-x-hsp-sm gap-x-hsp-xs gap-y-vsp-2xs gap-y-vsp-lg gap-y-vsp-md gap-y-vsp-xs gaps gate generate generated generation genuine geometry get github github-link go got graph gray-matter grid grid-cols-1 grid-cols-2 group group-focus-visible:text-accent group-focus-visible:underline group-focus-within:block group-hover:bg-fg group-hover:block group-hover:text-accent group-hover:text-bg group-hover:underline group-open:rotate-90 guard h-[0.5rem] h-[0.625rem] h-[0.875rem] h-[1.125rem] h-[1.25rem] h-[1.575rem] h-[14px] h-[1em] h-[1lh] h-[2rem] h-[3.5rem] h-[3rem] h-[90vh] h-[calc(100%-3rem)] h-[calc(100vh-3.5rem)] h-dvh h-full h-icon-lg h-icon-md h-icon-sm h-icon-xs h1 h1s h2 h2s h3 h4 h5 h6 half hand hand-copied handle handled handler handlers has hash-link have head head-links head-scripts header header- header-call:end header-call:start heading heading-h2 heading-h3 heading-h4 headings height here hex hidden highlight highlighter history hit horizontal host hover:bg-[color-mix(in_srgb,var(--color-surface)_80%,var(--color-fg)_20%)] hover:bg-accent-hover hover:bg-accent/10 hover:bg-surface hover:border-accent hover:border-accent-hover hover:border-fg hover:text-accent hover:text-accent-hover hover:text-fg hover:underline hr href hrefs html i i18n/theme. i2 i3 i4 icon identical idle idx if iframe image image-enlarge image/png img implementation import important imports in inactive inbox includes index info inherit inherited initial initialised injected inline inline-block inline-flex inner input input-clear ins inset-0 inside install instance instanceof instead instructions intended intent into invalid inverse inversion invoke is issues it italic item item- items items-baseline items-center items-start its itself javascript justify-between justify-center justify-end justify-start katex kbd keep keeps kept keyboard keyboard-shortcut keydown keystroke keywords khroma label landing language-switcher last:border-b-0 later launch layout leading-relaxed leading-snug leading-tight leaf- leak leaves left left-0 left:calc legend legitimate letter-spacing lg lg:block lg:border lg:border-fg lg:border-solid lg:flex lg:flex-col lg:flex-row lg:gap-hsp-xl lg:grid-cols-[repeat(auto-fit,minmax(12rem,1fr))] lg:h-[90vh] lg:hidden lg:justify-start lg:m-auto lg:max-h-[90vh] lg:max-w-[52.5rem] lg:ml-[var(--zd-sidebar-w)] lg:pt-vsp-2xl lg:px-hsp-2xl lg:py-vsp-2xl lg:text-left lg:w-[90vw] lg:w-[clamp(16rem,25%,22rem)] li li2 library light like likely line linger link link- links list-disc list-none listener literal literals lives llms llms-txt load local locale locales log longest-match look lostpointercapture lower luminance m m-0 m21 m6 main major make malformed malicious maps mark marks matches matching math math-display math-inline max max-h-[80vh] max-h-[85vh] max-h-[90vh] max-h-full max-h-none max-w-[46rem] max-w-[85%] max-w-[85vw] max-w-[90vw] max-w-[clamp(50rem,75vw,90rem)] max-w-full max-w-none max-width may mb-0 mb-vsp-2xs mb-vsp-lg mb-vsp-md mb-vsp-sm mb-vsp-xl mb-vsp-xs measures measuring mechanism menu merged mermaid message messages meta meta-knob metadata migration min-h-[60vh] min-h-[calc(100vh-3.5rem)] min-h-screen min-w-0 min-w-[10rem] min-w-[8rem] minor mirror mirrors missing ml-auto ml-hsp-2xl ml-hsp-lg ml-hsp-sm ml-hsp-xl mod mode module mounted mouseenter mouseleave mr-hsp-sm mt-0 mt-vsp-2xl mt-vsp-2xs mt-vsp-3xs mt-vsp-lg mt-vsp-md mt-vsp-sm mt-vsp-xl must mutates mutation mutations muted mx-auto my-vsp-lg my-vsp-md name named native nav nav-active nav-card- nav/doc navigating navigation navigations near needs nested new newly-swapped next no no-enlarge no-op no-repeat no-underline node node:buffer node:fs node:fs/promises node:module node:path nodes nofollow noindex non-empty non-light-dark non-persisted none noopener noreferrer normal noscript not not-object notable note notes now null number numeric object object-contain observe observer occurred of off og:description og:image og:image:alt og:image:height og:image:width og:title og:type og:url oklch ol old older on once one only onto opacity-60 open open/close option or original other others out outline-none over overflow overflow-auto overflow-hidden overflow-x-auto overflow-y-auto overflow-y:auto overwrite own p p-0 p-hsp-lg p-hsp-md p-hsp-sm p-hsp-xl package package-owned packages padding page page-loading page-loading-overlay page-loading-spinner page-navigate-end page-title pages pages/. paint paint-and-read palette pan panel panels paren-balance-aware parent parse parsed pass passed passes patch path paths pattern pb-[50vh] pb-vsp-md pb-vsp-xl pb-vsp-xs per per-link permanently persisted pi pick picked picks picocolors pins pipelines pl-[1.25rem] pl-hsp-lg pl-hsp-sm pl-hsp-xl place placeholder placeholder:text-muted plain plural plus pnpm pointer-events-none pointercancel pointerdown pointermove pointerup polite polygon polyline populates port position position:fixed pr-[4px] pr-hsp-lg pr-hsp-md pr-hsp-sm pr-hsp-xl pre pre-lowercased preact preact/compat preact/hooks preact/jsx-runtime preconnect prefix preload pres preserving print produce produced produces production project project-root-relative properties property props prose provided proxy pt-[0.15rem] pt-[2px] pt-vsp-3xs pt-vsp-md pt-vsp-sm pt-vsp-xl pt-vsp-xs ptag- public purely px px-hsp-2xl px-hsp-2xs px-hsp-lg px-hsp-md px-hsp-sm px-hsp-xl px-hsp-xs py-0 py-[2px] py-[calc(var(--spacing-vsp-xs)+0.15rem)] py-hsp-2xs py-hsp-sm py-hsp-xs py-vsp-2xs py-vsp-3xs py-vsp-lg py-vsp-md py-vsp-sm py-vsp-xl py-vsp-xs q query question r radius ramp range raw re-encode/decode re-querying re-render re-renders re-run re-running re-selects reach reached reaches read reading ready real real-value received receives recorded recovers redefine ref- references refetch refreshes regenerate regenerates regex reinit reinits relative release reload relying remove removed render rendered renders reorder repaint repeated repeating replaced replaces repopulate requires reserved reset resize resize-x resolve resolved resolves response restore restores result result-click results results-area retry return returns revision revisions rewrite right right- right-0 ro robots role roles root rotate-180 rotate-90 round round-trip rounded rounded-[0.75rem] rounded-bl-[0.25rem] rounded-bl-[1rem] rounded-br-[0.25rem] rounded-br-[1rem] rounded-full rounded-lg rounded-t-[1rem] rounds route router routes routes-src running runs runtime s safe safer same same-locale samp scale scanned schema-mismatch schema-missing scheme scored script script- script-eval script-evaluation script-injection scripts scroll scrollbar scrolled scrollend search search-index section section- see select select-none selection-bg selection-fg self self-start semibold sentinel separator serialised serialize server server-rendered set sets setting setup shadow-[0_1px_3px_color-mix(in_srgb,var(--color-fg)_8%,transparent)] shadow-lg shape share shared sharing shiki ship shipped ships short shortcut should show shown shrink-0 sidebar sidebar- sidebar-toggle-island sidebar-tree-island signal similarity single singular site-search site-tree-nav-island sitemap- sites size skill skills skipping skips slash slug sm:border sm:border-muted sm:flex-row sm:grid-cols-2 sm:h-auto sm:items-center sm:justify-between sm:max-h-[80vh] sm:max-w-[52rem] sm:mx-auto sm:my-[10vh] sm:rounded-lg small smooth snapshot snapshots so soft soft-nav solid some somehow source sources space-y-vsp-2xs spacing span spans spec specifier specifiers splitter square sr-only src stale start state state:state- status stay staying sticky still stop stored stray string strings strip stripe stroke-linecap stroke-linejoin stroke-width strong stronger style style-attribute styled styles stylesheet sub subagents subsequent success successful summary sup surface surfaces survives svg swap swapped swaps synchronous synchronously syntactically syntect t tab tab-item tab-panel tabindex table tablist tabpanel tabs tabs-container tabs-content tabs-nav tag tag- tag-item- tags tags:audit take tbody td temp-element template temporary temporary-element terminal terms test-results tested text text-accent text-bg text-body text-caption text-center text-chat-assistant-text text-chat-user-text text-code-fg text-danger text-decoration text-display text-fg text-heading text-info text-left text-micro text-muted text-muted/50 text-right text-small text-title text-warning text/plain textarea tfoot th that the thead their them theme theme-color theme-toggle theme/token then there these they this through throw tighten time tip title to toc toggle toggle-ai-chat toggle-design-token-panel toggles token tokens tolerates too toolbar top-0 top-[3.5rem] top-full top-level total touches tp tr tracked tracking-wider trade-off transition transition-[background,color,border-color] transition-[left,color] transition-colors transition-transform translate-x-0 translations transparent treats tree tree-child- tree-item- tree-top- trigger trigger:ai-chat trigger:design-token-panel triggers true truncate truncated try turn twitter:card twitter:creator twitter:description twitter:image twitter:site twitter:title two type typography u ul unavailable unchanged undefined under underline underlines understand unit-tested unknown unmaintained unobserve unreadable unrelated unreleased unset up uppercase usage use used user uses utf-8 utf8 utilities utility v v1 v2 val valid value value-reader values var variable variant verbatim version version- version-menu version-switcher vertical via video viewport virtual:zudo-doc-chrome-bindings virtual:zudo-doc-route-context visible vitesse-dark vocabulary w w-1/2 w-[0.5rem] w-[0.625rem] w-[0.875rem] w-[1.125rem] w-[1.575rem] w-[1.5rem] w-[1.75rem] w-[14px] w-[16px] w-[16rem] w-[18px] w-[1em] w-[280px] w-[2rem] w-[320px] w-[90vw] w-[var(--zd-sidebar-w)] w-dvw w-full w-icon-lg w-icon-md w-icon-sm w-icon-xs want warning was watching wbr wbr- we website weight went were what when where whereas whether which while whitespace-nowrap whitespace-pre whole wide-gamut width will with without word working worktrees would wrap wrapper wrappers written wrong wrote xl:flex xl:hidden y-scrollbar yet you your z-dropdown z-local-1 z-modal z-modal-backdrop z-sidebar z-toolbar zd-content zd-desktop-sidebar-toggle zd-doc-content-band zd-enlarge-btn zd-enlarge-dialog zd-enlarge-dialog-close zd-enlargeable zd-html-preview-code zd-mermaid-dialog zd-mermaid-enlargeable zd-mermaid-tool-btn zd-mermaid-toolbar zd-mermaid-transform zd-mermaid-viewport zd-sidebar-content-wrapper zd-sidebar-open zfb zfb:after-swap zfb:before-preparation zod zoom zudo-doc-design-tokens/v1 zudo-doc-design-tokens/v2 zudo-doc-design-tokens/v3 zudo-doc-sidebar-visible zudo-doc-sidebar-width zudo-doc-theme zudo-doc-theme-bridge");
|
package/dist/settings.d.ts
CHANGED
|
@@ -172,6 +172,16 @@ export interface VersionConfig {
|
|
|
172
172
|
/** Banner text shown on versioned pages (e.g., "unmaintained", "unreleased") */
|
|
173
173
|
banner?: "unmaintained" | "unreleased" | false;
|
|
174
174
|
}
|
|
175
|
+
export interface ChangelogConfig {
|
|
176
|
+
/** Directory containing one MDX/MD changelog page per released version. */
|
|
177
|
+
sourceDir: string;
|
|
178
|
+
/** File to overwrite with the generated CommonMark changelog. */
|
|
179
|
+
outputFile: string;
|
|
180
|
+
/** Optional package/project label used in the generated preamble. */
|
|
181
|
+
packageName?: string;
|
|
182
|
+
/** Document heading. Defaults to "Changelog". */
|
|
183
|
+
title?: string;
|
|
184
|
+
}
|
|
175
185
|
export interface MetaTagsConfig {
|
|
176
186
|
/** Emit <meta name="description">. Default true. */
|
|
177
187
|
description: boolean;
|
|
@@ -278,6 +288,7 @@ export interface Settings {
|
|
|
278
288
|
tagGovernance: TagGovernanceMode;
|
|
279
289
|
tagVocabulary: boolean;
|
|
280
290
|
llmsTxt: boolean;
|
|
291
|
+
changelogs?: ChangelogConfig[] | false;
|
|
281
292
|
math: boolean;
|
|
282
293
|
cjkFriendly: boolean;
|
|
283
294
|
onBrokenMarkdownLinks: "warn" | "error" | "ignore";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@takazudo/zudo-doc",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.1.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "zudo-doc framework primitives layer that sits on top of zfb's engine — sidebar, theme, TOC, breadcrumb, layouts, head injection, View Transitions, SSR-skip wrappers (per ADR-003).",
|
|
6
6
|
"license": "MIT",
|
|
@@ -115,6 +115,10 @@
|
|
|
115
115
|
"types": "./dist/integrations/llms-txt/index.d.ts",
|
|
116
116
|
"default": "./dist/integrations/llms-txt/index.js"
|
|
117
117
|
},
|
|
118
|
+
"./integrations/changelog": {
|
|
119
|
+
"types": "./dist/integrations/changelog/index.d.ts",
|
|
120
|
+
"default": "./dist/integrations/changelog/index.js"
|
|
121
|
+
},
|
|
118
122
|
"./integrations/search-index": {
|
|
119
123
|
"types": "./dist/integrations/search-index/index.d.ts",
|
|
120
124
|
"default": "./dist/integrations/search-index/index.js"
|
|
@@ -175,6 +179,10 @@
|
|
|
175
179
|
"types": "./dist/plugins/llms-txt.d.ts",
|
|
176
180
|
"default": "./dist/plugins/llms-txt.js"
|
|
177
181
|
},
|
|
182
|
+
"./plugins/changelog": {
|
|
183
|
+
"types": "./dist/plugins/changelog.d.ts",
|
|
184
|
+
"default": "./dist/plugins/changelog.js"
|
|
185
|
+
},
|
|
178
186
|
"./plugins/search-index": {
|
|
179
187
|
"types": "./dist/plugins/search-index.d.ts",
|
|
180
188
|
"default": "./dist/plugins/search-index.js"
|
|
@@ -536,12 +544,13 @@
|
|
|
536
544
|
"bin",
|
|
537
545
|
"eject",
|
|
538
546
|
"routes-src",
|
|
539
|
-
"README.md"
|
|
547
|
+
"README.md",
|
|
548
|
+
"CHANGELOG.md"
|
|
540
549
|
],
|
|
541
550
|
"peerDependencies": {
|
|
542
551
|
"preact": "^10.29.1",
|
|
543
|
-
"@takazudo/zfb": "^0.1.0-next.
|
|
544
|
-
"@takazudo/zfb-runtime": "^0.1.0-next.
|
|
552
|
+
"@takazudo/zfb": "^0.1.0-next.77",
|
|
553
|
+
"@takazudo/zfb-runtime": "^0.1.0-next.77",
|
|
545
554
|
"@takazudo/zudo-doc-history-server": "^3.0.0",
|
|
546
555
|
"@takazudo/zdtp": "^0.4.5",
|
|
547
556
|
"shiki": "^4.0.2",
|
|
@@ -584,9 +593,9 @@
|
|
|
584
593
|
"typescript": "^5.0.0",
|
|
585
594
|
"vitest": "^4.1.0",
|
|
586
595
|
"zod": "^4.3.6",
|
|
587
|
-
"@takazudo/zfb": "0.1.0-next.
|
|
588
|
-
"@takazudo/zfb-runtime": "0.1.0-next.
|
|
589
|
-
"@takazudo/zudo-doc-history-server": "3.
|
|
596
|
+
"@takazudo/zfb": "0.1.0-next.77",
|
|
597
|
+
"@takazudo/zfb-runtime": "0.1.0-next.77",
|
|
598
|
+
"@takazudo/zudo-doc-history-server": "3.1.0"
|
|
590
599
|
},
|
|
591
600
|
"scripts": {
|
|
592
601
|
"build": "tsup && tsc -p tsconfig.build.json",
|