@zudojs/docs 0.0.1

package/LICENSE

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

package/README.md

@@ -0,0 +1,38 @@
+# @zudojs/docs
+
+Documentation infrastructure with structured document model, registry, validation, navigation, frontmatter parsing, and markdown/JSON generation.
+
+## Installation
+
+```bash
+npm install @zudojs/docs
+```
+
+## Quick Start
+
+```typescript
+import { createDocumentRegistry } from "@zudojs/docs";
+
+const registry = createDocumentRegistry();
+
+registry.register({
+  id: "getting-started",
+  title: "Getting Started",
+  content: "# Getting Started\n\nWelcome to Zudojs...",
+});
+```
+
+## Features
+
+- Document model with frontmatter
+- Document registry and discovery
+- Navigation tree generation
+- Markdown and JSON generation
+- Document validation
+
+## Use Cases
+
+- API documentation
+- User guides
+- Knowledge bases
+- Documentation sites

package/dist/docsTypes/documentationContent.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Content model for documentation documents.
+ *
+ * Supports multiple content formats: markdown, MDX, HTML,
+ * and structured AST nodes for multi-format rendering.
+ */
+/** A single node in a structured documentation AST. */
+export type DocumentationNode = HeadingNode | ParagraphNode | CodeNode | ListNode | LinkNode | TableNode | QuoteNode | CalloutNode;
+/** Heading node with level 1-6. */
+export interface HeadingNode {
+    readonly type: "heading";
+    readonly level: 1 | 2 | 3 | 4 | 5 | 6;
+    readonly value: string;
+}
+/** Paragraph node. */
+export interface ParagraphNode {
+    readonly type: "paragraph";
+    readonly value: string;
+}
+/** Code block node. */
+export interface CodeNode {
+    readonly type: "code";
+    readonly language?: string;
+    readonly value: string;
+}
+/** List node (ordered or unordered). */
+export interface ListNode {
+    readonly type: "list";
+    readonly ordered: boolean;
+    readonly items: readonly string[];
+}
+/** Link node. */
+export interface LinkNode {
+    readonly type: "link";
+    readonly href: string;
+    readonly value: string;
+}
+/** Table node. */
+export interface TableNode {
+    readonly type: "table";
+    readonly headers: readonly string[];
+    readonly rows: readonly (readonly string[])[];
+}
+/** Blockquote node. */
+export interface QuoteNode {
+    readonly type: "quote";
+    readonly value: string;
+}
+/** Callout/admonition node. */
+export interface CalloutNode {
+    readonly type: "callout";
+    readonly kind: "note" | "warning" | "tip" | "danger";
+    readonly value: string;
+}
+/** Markdown content. */
+export interface MarkdownContent {
+    readonly type: "markdown";
+    readonly value: string;
+}
+/** MDX content. */
+export interface MDXContent {
+    readonly type: "mdx";
+    readonly value: string;
+}
+/** HTML content. */
+export interface HTMLContent {
+    readonly type: "html";
+    readonly value: string;
+}
+/** Structured content using AST nodes. */
+export interface StructuredContent {
+    readonly type: "structured";
+    readonly nodes: readonly DocumentationNode[];
+}
+/**
+ * Union of all supported content types.
+ * A document can use any of these formats.
+ */
+export type DocumentationContent = MarkdownContent | MDXContent | HTMLContent | StructuredContent;
+//# sourceMappingURL=documentationContent.d.ts.map

package/dist/docsTypes/documentationContent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentationContent.d.ts","sourceRoot":"","sources":["../../src/docsTypes/documentationContent.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,uDAAuD;AACvD,MAAM,MAAM,iBAAiB,GACzB,WAAW,GACX,aAAa,GACb,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,SAAS,GACT,WAAW,CAAC;AAEhB,mCAAmC;AACnC,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACtC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED,sBAAsB;AACtB,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED,uBAAuB;AACvB,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED,wCAAwC;AACxC,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;CACnC;AAED,iBAAiB;AACjB,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED,kBAAkB;AAClB,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC;CAC/C;AAED,uBAAuB;AACvB,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED,+BAA+B;AAC/B,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,KAAK,GAAG,QAAQ,CAAC;IACrD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED,wBAAwB;AACxB,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED,mBAAmB;AACnB,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED,oBAAoB;AACpB,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED,0CAA0C;AAC1C,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,KAAK,EAAE,SAAS,iBAAiB,EAAE,CAAC;CAC9C;AAED;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAC9B,eAAe,GAAG,UAAU,GAAG,WAAW,GAAG,iBAAiB,CAAC"}

package/dist/docsTypes/documentationContent.js

@@ -0,0 +1,8 @@
+/**
+ * Content model for documentation documents.
+ *
+ * Supports multiple content formats: markdown, MDX, HTML,
+ * and structured AST nodes for multi-format rendering.
+ */
+export {};
+//# sourceMappingURL=documentationContent.js.map

package/dist/docsTypes/documentationContent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentationContent.js","sourceRoot":"","sources":["../../src/docsTypes/documentationContent.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/dist/docsTypes/documentationDocument.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Core document interface for documentation pages.
+ *
+ * Documents are the fundamental unit of content in the docs package.
+ * Each document has a stable ID, structured content, and metadata.
+ */
+import type { DocumentationContent } from "./documentationContent.js";
+import type { DocumentationCategory, DocumentationMetadata, DocumentationStatus } from "./documentationMetadata.js";
+/**
+ * A documentation page.
+ *
+ * IDs must be stable dot-separated identifiers (e.g. "guides.http.routing").
+ * Titles can change without breaking links.
+ */
+export interface DocumentationDocument {
+    readonly id: string;
+    readonly title: string;
+    readonly description?: string;
+    readonly content: DocumentationContent;
+    readonly category?: DocumentationCategory;
+    readonly tags?: readonly string[];
+    readonly version?: string;
+    readonly status?: DocumentationStatus;
+    readonly metadata?: DocumentationMetadata;
+    readonly deprecated?: boolean;
+    readonly deprecatedMessage?: string;
+    readonly visibility?: "SERVER" | "CLIENT";
+}
+//# sourceMappingURL=documentationDocument.d.ts.map

package/dist/docsTypes/documentationDocument.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentationDocument.d.ts","sourceRoot":"","sources":["../../src/docsTypes/documentationDocument.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,KAAK,EACV,qBAAqB,EACrB,qBAAqB,EACrB,mBAAmB,EACpB,MAAM,4BAA4B,CAAC;AAEpC;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,OAAO,EAAE,oBAAoB,CAAC;IACvC,QAAQ,CAAC,QAAQ,CAAC,EAAE,qBAAqB,CAAC;IAC1C,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,CAAC;IACtC,QAAQ,CAAC,QAAQ,CAAC,EAAE,qBAAqB,CAAC;IAC1C,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAC9B,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACpC,QAAQ,CAAC,UAAU,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;CAC3C"}

package/dist/docsTypes/documentationDocument.js

@@ -0,0 +1,8 @@
+/**
+ * Core document interface for documentation pages.
+ *
+ * Documents are the fundamental unit of content in the docs package.
+ * Each document has a stable ID, structured content, and metadata.
+ */
+export {};
+//# sourceMappingURL=documentationDocument.js.map

package/dist/docsTypes/documentationDocument.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentationDocument.js","sourceRoot":"","sources":["../../src/docsTypes/documentationDocument.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/dist/docsTypes/documentationMetadata.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Metadata and classification types for documentation.
+ */
+/** High-level categories for documentation pages. */
+export type DocumentationCategory = "introduction" | "guide" | "tutorial" | "reference" | "api" | "architecture" | "configuration" | "deployment" | "security" | "migration" | "examples";
+/** Status of a documentation page. */
+export type DocumentationStatus = "stable" | "experimental" | "beta" | "deprecated" | "internal";
+/** API symbol kind for auto-generated references. */
+export type APISymbolKind = "function" | "class" | "interface" | "type" | "enum" | "variable" | "namespace" | "method" | "property";
+/** Source location for an API symbol. */
+export interface SourceLocation {
+    readonly file: string;
+    readonly line: number;
+    readonly column?: number;
+}
+/** An API symbol extracted from source code. */
+export interface APISymbol {
+    readonly name: string;
+    readonly kind: APISymbolKind;
+    readonly description?: string;
+    readonly source?: SourceLocation;
+    readonly deprecated?: boolean;
+    readonly examples?: readonly APIExample[];
+    readonly parameters?: readonly APIParameter[];
+    readonly returnType?: string;
+}
+/** An API example for documentation. */
+export interface APIExample {
+    readonly id: string;
+    readonly title?: string;
+    readonly language: string;
+    readonly code: string;
+    readonly description?: string;
+}
+/** Parameter for an API symbol. */
+export interface APIParameter {
+    readonly name: string;
+    readonly type?: string;
+    readonly description?: string;
+    readonly optional?: boolean;
+    readonly defaultValue?: string;
+}
+/** Metadata attached to a documentation document. */
+export interface DocumentationMetadata {
+    readonly owner?: string;
+    readonly team?: string;
+    readonly createdAt?: Date;
+    readonly updatedAt?: Date;
+    readonly version?: string;
+    readonly ticket?: string;
+    readonly tags?: readonly string[];
+}
+/** A version entry for versioned documentation. */
+export interface DocumentationVersion {
+    readonly version: string;
+    readonly label?: string;
+    readonly deprecated?: boolean;
+    readonly latest?: boolean;
+}
+//# sourceMappingURL=documentationMetadata.d.ts.map

package/dist/docsTypes/documentationMetadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentationMetadata.d.ts","sourceRoot":"","sources":["../../src/docsTypes/documentationMetadata.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,qDAAqD;AACrD,MAAM,MAAM,qBAAqB,GAC7B,cAAc,GACd,OAAO,GACP,UAAU,GACV,WAAW,GACX,KAAK,GACL,cAAc,GACd,eAAe,GACf,YAAY,GACZ,UAAU,GACV,WAAW,GACX,UAAU,CAAC;AAEf,sCAAsC;AACtC,MAAM,MAAM,mBAAmB,GAC7B,QAAQ,GAAG,cAAc,GAAG,MAAM,GAAG,YAAY,GAAG,UAAU,CAAC;AAEjE,qDAAqD;AACrD,MAAM,MAAM,aAAa,GACrB,UAAU,GACV,OAAO,GACP,WAAW,GACX,MAAM,GACN,MAAM,GACN,UAAU,GACV,WAAW,GACX,QAAQ,GACR,UAAU,CAAC;AAEf,yCAAyC;AACzC,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,gDAAgD;AAChD,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,MAAM,CAAC,EAAE,cAAc,CAAC;IACjC,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,UAAU,EAAE,CAAC;IAC1C,QAAQ,CAAC,UAAU,CAAC,EAAE,SAAS,YAAY,EAAE,CAAC;IAC9C,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,wCAAwC;AACxC,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,mCAAmC;AACnC,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,qDAAqD;AACrD,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC;IAC1B,QAAQ,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC;IAC1B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACnC;AAED,mDAAmD;AACnD,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAC9B,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;CAC3B"}

package/dist/docsTypes/documentationMetadata.js

@@ -0,0 +1,5 @@
+/**
+ * Metadata and classification types for documentation.
+ */
+export {};
+//# sourceMappingURL=documentationMetadata.js.map

package/dist/docsTypes/documentationMetadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentationMetadata.js","sourceRoot":"","sources":["../../src/docsTypes/documentationMetadata.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/dist/docsTypes/documentationNavigation.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Navigation model for documentation.
+ *
+ * Navigation is modeled separately from documents so that
+ * structure can be controlled independently of content.
+ */
+/** A single item in the documentation navigation tree. */
+export interface DocumentationNavigationItem {
+    readonly title: string;
+    readonly documentId?: string;
+    readonly children?: readonly DocumentationNavigationItem[];
+}
+/** Breadcrumb entry for a document. */
+export interface DocumentationBreadcrumb {
+    readonly title: string;
+    readonly documentId?: string;
+}
+/** Search document for indexing. */
+export interface SearchDocument {
+    readonly id: string;
+    readonly title: string;
+    readonly content: string;
+    readonly tags: readonly string[];
+    readonly path: string;
+}
+/** Search result returned from a search query. */
+export interface SearchResult {
+    readonly id: string;
+    readonly title: string;
+    readonly path: string;
+    readonly excerpt?: string;
+    readonly score?: number;
+}
+//# sourceMappingURL=documentationNavigation.d.ts.map

package/dist/docsTypes/documentationNavigation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentationNavigation.d.ts","sourceRoot":"","sources":["../../src/docsTypes/documentationNavigation.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,0DAA0D;AAC1D,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,2BAA2B,EAAE,CAAC;CAC5D;AAED,uCAAuC;AACvC,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,oCAAoC;AACpC,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;IACjC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,kDAAkD;AAClD,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;CACzB"}

package/dist/docsTypes/documentationNavigation.js

@@ -0,0 +1,8 @@
+/**
+ * Navigation model for documentation.
+ *
+ * Navigation is modeled separately from documents so that
+ * structure can be controlled independently of content.
+ */
+export {};
+//# sourceMappingURL=documentationNavigation.js.map

package/dist/docsTypes/documentationNavigation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentationNavigation.js","sourceRoot":"","sources":["../../src/docsTypes/documentationNavigation.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/dist/docsTypes/documentationProvider.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Provider and source loader types for documentation.
+ *
+ * Providers abstract where documentation comes from.
+ * Source loaders abstract how documentation is read.
+ */
+import type { DocumentationDocument } from "./documentationDocument.js";
+/** A provider that supplies documentation documents. */
+export interface DocumentationProvider {
+    get(id: string): DocumentationDocument | undefined;
+    getAll(): readonly DocumentationDocument[];
+}
+/** Loads content from a documentation source. */
+export interface DocumentationSourceLoader {
+    load(source: string): Promise<string>;
+}
+/** Sanitizer for rendered content (HTML, MDX). */
+export interface DocumentationSanitizer {
+    sanitize(content: string): string;
+}
+//# sourceMappingURL=documentationProvider.d.ts.map

package/dist/docsTypes/documentationProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentationProvider.d.ts","sourceRoot":"","sources":["../../src/docsTypes/documentationProvider.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAExE,wDAAwD;AACxD,MAAM,WAAW,qBAAqB;IACpC,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS,CAAC;IACnD,MAAM,IAAI,SAAS,qBAAqB,EAAE,CAAC;CAC5C;AAED,iDAAiD;AACjD,MAAM,WAAW,yBAAyB;IACxC,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CACvC;AAED,kDAAkD;AAClD,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;CACnC"}

package/dist/docsTypes/documentationProvider.js

@@ -0,0 +1,8 @@
+/**
+ * Provider and source loader types for documentation.
+ *
+ * Providers abstract where documentation comes from.
+ * Source loaders abstract how documentation is read.
+ */
+export {};
+//# sourceMappingURL=documentationProvider.js.map

package/dist/docsTypes/documentationProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentationProvider.js","sourceRoot":"","sources":["../../src/docsTypes/documentationProvider.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/dist/docsTypes/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @zudojs/docs/docsTypes
+ *
+ * Core type definitions for the documentation model.
+ */
+export type { DocumentationNode, HeadingNode, ParagraphNode, CodeNode, ListNode, LinkNode, TableNode, QuoteNode, CalloutNode, MarkdownContent, MDXContent, HTMLContent, StructuredContent, DocumentationContent, } from "./documentationContent.js";
+export type { DocumentationCategory, DocumentationStatus, APISymbolKind, SourceLocation, APISymbol, APIParameter, DocumentationMetadata, DocumentationVersion, } from "./documentationMetadata.js";
+export type { DocumentationDocument } from "./documentationDocument.js";
+export type { DocumentationNavigationItem, DocumentationBreadcrumb, SearchDocument, SearchResult, } from "./documentationNavigation.js";
+export type { DocumentationProvider, DocumentationSourceLoader, DocumentationSanitizer, } from "./documentationProvider.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/docsTypes/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/docsTypes/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,YAAY,EACV,iBAAiB,EACjB,WAAW,EACX,aAAa,EACb,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,SAAS,EACT,WAAW,EACX,eAAe,EACf,UAAU,EACV,WAAW,EACX,iBAAiB,EACjB,oBAAoB,GACrB,MAAM,2BAA2B,CAAC;AAEnC,YAAY,EACV,qBAAqB,EACrB,mBAAmB,EACnB,aAAa,EACb,cAAc,EACd,SAAS,EACT,YAAY,EACZ,qBAAqB,EACrB,oBAAoB,GACrB,MAAM,4BAA4B,CAAC;AAEpC,YAAY,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAExE,YAAY,EACV,2BAA2B,EAC3B,uBAAuB,EACvB,cAAc,EACd,YAAY,GACb,MAAM,8BAA8B,CAAC;AAEtC,YAAY,EACV,qBAAqB,EACrB,yBAAyB,EACzB,sBAAsB,GACvB,MAAM,4BAA4B,CAAC"}

package/dist/docsTypes/index.js

@@ -0,0 +1,7 @@
+/**
+ * @zudojs/docs/docsTypes
+ *
+ * Core type definitions for the documentation model.
+ */
+export {};
+//# sourceMappingURL=index.js.map

package/dist/docsTypes/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/docsTypes/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}

package/dist/document/documentBuilder.core.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Fluent builder for creating documentation documents.
+ *
+ * Provides a chainable API that validates inputs and
+ * produces immutable DocumentationDocument objects.
+ */
+import type { DocumentationContent, DocumentationDocument, DocumentationCategory, DocumentationMetadata, DocumentationStatus } from "../docsTypes/index.js";
+/**
+ * Options for creating a document via the builder.
+ */
+export interface DocumentBuilderOptions {
+    readonly id: string;
+    readonly title: string;
+    readonly description?: string;
+    readonly content: DocumentationContent;
+    readonly category?: DocumentationCategory;
+    readonly tags?: readonly string[];
+    readonly version?: string;
+    readonly status?: DocumentationStatus;
+    readonly metadata?: DocumentationMetadata;
+    readonly deprecated?: boolean;
+    readonly deprecatedMessage?: string;
+    readonly visibility?: "SERVER" | "CLIENT";
+}
+/**
+ * Creates a documentation document from structured options.
+ *
+ * @example
+ * ```ts
+ * const doc = createDocument({
+ *   id: "guides.http.routing",
+ *   title: "HTTP Routing",
+ *   content: { type: "markdown", value: "# Routing\n\n..." },
+ *   category: "guide",
+ *   tags: ["http", "routing"],
+ * });
+ * ```
+ */
+export declare function createDocument(options: DocumentBuilderOptions): DocumentationDocument;
+/**
+ * Creates a markdown document.
+ */
+export declare function createMarkdownDocument(id: string, title: string, markdown: string, options?: Partial<DocumentBuilderOptions>): DocumentationDocument;
+/**
+ * Creates a structured document from AST nodes.
+ */
+export declare function createStructuredDocument(id: string, title: string, nodes: DocumentationContent extends {
+    readonly nodes: infer N;
+} ? N : never, options?: Partial<DocumentBuilderOptions>): DocumentationDocument;
+//# sourceMappingURL=documentBuilder.core.d.ts.map

package/dist/document/documentBuilder.core.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentBuilder.core.d.ts","sourceRoot":"","sources":["../../src/document/documentBuilder.core.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EACV,oBAAoB,EACpB,qBAAqB,EACrB,qBAAqB,EACrB,qBAAqB,EACrB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAE/B;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,OAAO,EAAE,oBAAoB,CAAC;IACvC,QAAQ,CAAC,QAAQ,CAAC,EAAE,qBAAqB,CAAC;IAC1C,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,CAAC;IACtC,QAAQ,CAAC,QAAQ,CAAC,EAAE,qBAAqB,CAAC;IAC1C,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAC9B,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACpC,QAAQ,CAAC,UAAU,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;CAC3C;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAC5B,OAAO,EAAE,sBAAsB,GAC9B,qBAAqB,CAiBvB;AAoBD;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GACxC,qBAAqB,CAOvB;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,oBAAoB,SAAS;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,EAC3E,OAAO,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GACxC,qBAAqB,CAUvB"}

package/dist/document/documentBuilder.core.js

@@ -0,0 +1,78 @@
+/**
+ * Fluent builder for creating documentation documents.
+ *
+ * Provides a chainable API that validates inputs and
+ * produces immutable DocumentationDocument objects.
+ */
+/**
+ * Creates a documentation document from structured options.
+ *
+ * @example
+ * ```ts
+ * const doc = createDocument({
+ *   id: "guides.http.routing",
+ *   title: "HTTP Routing",
+ *   content: { type: "markdown", value: "# Routing\n\n..." },
+ *   category: "guide",
+ *   tags: ["http", "routing"],
+ * });
+ * ```
+ */
+export function createDocument(options) {
+    validateDocumentOptions(options);
+    return Object.freeze({
+        id: options.id,
+        title: options.title,
+        description: options.description,
+        content: options.content,
+        category: options.category,
+        tags: options.tags ? Object.freeze([...options.tags]) : undefined,
+        version: options.version,
+        status: options.status,
+        metadata: options.metadata,
+        deprecated: options.deprecated,
+        deprecatedMessage: options.deprecatedMessage,
+        visibility: options.visibility,
+    });
+}
+/**
+ * Validates document builder options.
+ * Throws on invalid input.
+ */
+function validateDocumentOptions(options) {
+    if (!options.id || options.id.trim().length === 0) {
+        throw new Error("Document ID is required.");
+    }
+    if (!options.title || options.title.trim().length === 0) {
+        throw new Error("Document title is required.");
+    }
+    if (!options.content) {
+        throw new Error("Document content is required.");
+    }
+}
+/**
+ * Creates a markdown document.
+ */
+export function createMarkdownDocument(id, title, markdown, options) {
+    return createDocument({
+        id,
+        title,
+        content: { type: "markdown", value: markdown },
+        ...options,
+    });
+}
+/**
+ * Creates a structured document from AST nodes.
+ */
+export function createStructuredDocument(id, title, nodes, options) {
+    return createDocument({
+        id,
+        title,
+        content: {
+            type: "structured",
+            value: nodes,
+        },
+        ...options,
+    });
+}
+//# sourceMappingURL=documentBuilder.core.js.map

package/dist/document/documentBuilder.core.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentBuilder.core.js","sourceRoot":"","sources":["../../src/document/documentBuilder.core.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AA4BH;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,cAAc,CAC5B,OAA+B;IAE/B,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAEjC,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,EAAE,EAAE,OAAO,CAAC,EAAE;QACd,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;QACjE,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,UAAU,EAAE,OAAO,CAAC,UAAU;QAC9B,iBAAiB,EAAE,OAAO,CAAC,iBAAiB;QAC5C,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,SAAS,uBAAuB,CAAC,OAA+B;IAC9D,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAClD,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC9C,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxD,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACjD,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACnD,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,sBAAsB,CACpC,EAAU,EACV,KAAa,EACb,QAAgB,EAChB,OAAyC;IAEzC,OAAO,cAAc,CAAC;QACpB,EAAE;QACF,KAAK;QACL,OAAO,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE;QAC9C,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CACtC,EAAU,EACV,KAAa,EACb,KAA2E,EAC3E,OAAyC;IAEzC,OAAO,cAAc,CAAC;QACpB,EAAE;QACF,KAAK;QACL,OAAO,EAAE;YACP,IAAI,EAAE,YAAY;YAClB,KAAK,EAAE,KAAK;SACsB;QACpC,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC"}

package/dist/document/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @zudojs/docs/document
+ *
+ * Document model and builder for creating documentation pages.
+ */
+export { createDocument, createMarkdownDocument, createStructuredDocument, } from "./documentBuilder.core.js";
+export type { DocumentBuilderOptions } from "./documentBuilder.core.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/document/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/document/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,cAAc,EACd,sBAAsB,EACtB,wBAAwB,GACzB,MAAM,2BAA2B,CAAC;AAEnC,YAAY,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC"}

package/dist/document/index.js

@@ -0,0 +1,7 @@
+/**
+ * @zudojs/docs/document
+ *
+ * Document model and builder for creating documentation pages.
+ */
+export { createDocument, createMarkdownDocument, createStructuredDocument, } from "./documentBuilder.core.js";
+//# sourceMappingURL=index.js.map

package/dist/document/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/document/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,cAAc,EACd,sBAAsB,EACtB,wBAAwB,GACzB,MAAM,2BAA2B,CAAC"}

package/dist/examples/examples.core.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Code example modeling and validation.
+ *
+ * Examples are first-class objects that can be validated,
+ * rendered, and included in generated documentation.
+ */
+import type { DocumentationMetadata } from "../docsTypes/index.js";
+/**
+ * A code example for documentation.
+ */
+export interface DocumentationExample {
+    readonly id: string;
+    readonly title?: string;
+    readonly language: string;
+    readonly code: string;
+    readonly description?: string;
+    readonly metadata?: DocumentationMetadata;
+}
+/**
+ * Result of validating an example.
+ */
+export interface ExampleValidationResult {
+    readonly valid: boolean;
+    readonly errors: readonly string[];
+}
+/**
+ * Validates a documentation example.
+ */
+export declare function validateExample(example: DocumentationExample): ExampleValidationResult;
+/**
+ * Renders an example as a markdown code block.
+ */
+export declare function renderExampleMarkdown(example: DocumentationExample): string;
+/**
+ * Renders an example as a JSON-serializable object.
+ */
+export declare function exampleToJSON(example: DocumentationExample): Record<string, unknown>;
+//# sourceMappingURL=examples.core.d.ts.map

package/dist/examples/examples.core.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"examples.core.d.ts","sourceRoot":"","sources":["../../src/examples/examples.core.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,QAAQ,CAAC,EAAE,qBAAqB,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;CACpC;AAED;;GAEG;AACH,wBAAgB,eAAe,CAC7B,OAAO,EAAE,oBAAoB,GAC5B,uBAAuB,CAmBzB;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,oBAAoB,GAAG,MAAM,CAkB3E;AAED;;GAEG;AACH,wBAAgB,aAAa,CAC3B,OAAO,EAAE,oBAAoB,GAC5B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAQzB"}