@takazudo/zudo-doc 3.0.0 → 3.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.
Files changed (31) hide show
  1. package/CHANGELOG.md +1052 -0
  2. package/README.md +4 -0
  3. package/dist/code-syntax/mermaid-init-script.js +46 -1
  4. package/dist/doc-page-renderer/index.d.ts +1 -0
  5. package/dist/doc-page-renderer/index.js +2 -0
  6. package/dist/doc-page-shell/index.d.ts +2 -0
  7. package/dist/doc-page-shell/index.js +2 -0
  8. package/dist/doclayout/doc-layout.d.ts +9 -0
  9. package/dist/doclayout/doc-layout.js +2 -0
  10. package/dist/features.css +19 -0
  11. package/dist/home-page/index.d.ts +8 -0
  12. package/dist/home-page/index.js +3 -1
  13. package/dist/integrations/changelog/emit.d.ts +2 -0
  14. package/dist/integrations/changelog/emit.js +24 -0
  15. package/dist/integrations/changelog/generate.d.ts +2 -0
  16. package/dist/integrations/changelog/generate.js +24 -0
  17. package/dist/integrations/changelog/index.d.ts +5 -0
  18. package/dist/integrations/changelog/index.js +11 -0
  19. package/dist/integrations/changelog/load.d.ts +3 -0
  20. package/dist/integrations/changelog/load.js +79 -0
  21. package/dist/integrations/changelog/sanitize.d.ts +10 -0
  22. package/dist/integrations/changelog/sanitize.js +24 -0
  23. package/dist/integrations/changelog/types.d.ts +31 -0
  24. package/dist/integrations/changelog/types.js +0 -0
  25. package/dist/plugins/changelog.d.ts +3 -0
  26. package/dist/plugins/changelog.js +17 -0
  27. package/dist/preset.d.ts +10 -1
  28. package/dist/preset.js +10 -1
  29. package/dist/safelist.css +1 -1
  30. package/dist/settings.d.ts +13 -0
  31. package/package.json +17 -8
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;
@@ -249,6 +259,8 @@ export interface Settings {
249
259
  siteDescription: string;
250
260
  base: string;
251
261
  trailingSlash: boolean;
262
+ /** Minify production HTML output from `zfb build`. Defaults to `true` when omitted. */
263
+ minifyHtml?: boolean;
252
264
  docsDir: string;
253
265
  defaultLocale: string;
254
266
  locales: Record<string, LocaleConfig>;
@@ -278,6 +290,7 @@ export interface Settings {
278
290
  tagGovernance: TagGovernanceMode;
279
291
  tagVocabulary: boolean;
280
292
  llmsTxt: boolean;
293
+ changelogs?: ChangelogConfig[] | false;
281
294
  math: boolean;
282
295
  cjkFriendly: boolean;
283
296
  onBrokenMarkdownLinks: "warn" | "error" | "ignore";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@takazudo/zudo-doc",
3
- "version": "3.0.0",
3
+ "version": "3.2.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,13 +544,14 @@
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.76",
544
- "@takazudo/zfb-runtime": "^0.1.0-next.76",
545
- "@takazudo/zudo-doc-history-server": "^3.0.0",
552
+ "@takazudo/zfb": "^0.1.0-next.78",
553
+ "@takazudo/zfb-runtime": "^0.1.0-next.78",
554
+ "@takazudo/zudo-doc-history-server": "^3.1.0",
546
555
  "@takazudo/zdtp": "^0.4.5",
547
556
  "shiki": "^4.0.2",
548
557
  "zod": "^4.3.6",
@@ -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.76",
588
- "@takazudo/zfb-runtime": "0.1.0-next.76",
589
- "@takazudo/zudo-doc-history-server": "3.0.0"
596
+ "@takazudo/zfb": "0.1.0-next.78",
597
+ "@takazudo/zfb-runtime": "0.1.0-next.78",
598
+ "@takazudo/zudo-doc-history-server": "3.2.0"
590
599
  },
591
600
  "scripts": {
592
601
  "build": "tsup && tsc -p tsconfig.build.json",