docmedown 0.1.7 → 0.9.0

package/schemas/docs.schema.json

@@ -1,182 +1,187 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://raw.githubusercontent.com/gabrielmsilva00/docmedown/main/schemas/docs.schema.json",
-  "title": "DocMeDown documentation configuration",
-  "description": "Configuration for a DocMeDown documentation root. A directory containing docs.json is an independent documentation site.",
-  "type": "object",
-  "additionalProperties": false,
-  "properties": {
-    "$schema": { "type": "string", "format": "uri" },
-    "name": { "type": "string", "minLength": 1 },
-    "tagline": { "type": "string" },
-    "description": { "type": "string" },
-    "version": { "type": "string" },
-    "rootDoc": { "type": "string", "minLength": 1 },
-    "home": {
-      "type": "string",
-      "minLength": 1,
-      "description": "Documentation home document (path or slug) or an explicit link. Defaults to README.md, PROJECT.md, ABOUT.md, or INDEX.md at the documentation root (case-sensitive pass first, then case-insensitive), then the alphabetically first Markdown document."
-    },
-    "source": { "$ref": "#/$defs/source" },
-    "theme": { "$ref": "#/$defs/theme" },
-    "nav": { "type": "array", "items": { "$ref": "#/$defs/navLink" } },
-    "socials": { "type": "array", "items": { "$ref": "#/$defs/socialLink" } },
-    "sidebar": { "type": "array", "items": { "$ref": "#/$defs/sidebarItem" } },
-    "autoIndex": { "$ref": "#/$defs/autoIndex" },
-    "search": { "$ref": "#/$defs/search" },
-    "offline": { "$ref": "#/$defs/offline" },
-    "footer": { "$ref": "#/$defs/footer" },
-    "componentsUrl": { "type": "string" },
-    "editUrl": { "type": "string" }
-  },
-  "$defs": {
-    "navLink": {
-      "type": "object",
-      "additionalProperties": false,
-      "required": ["label", "href"],
-      "properties": {
-        "label": { "type": "string", "minLength": 1 },
-        "href": { "type": "string", "minLength": 1 },
-        "external": { "type": "boolean" },
-        "icon": { "type": "string" }
-      }
-    },
-    "socialLink": {
-      "type": "object",
-      "additionalProperties": false,
-      "required": ["type", "url"],
-      "properties": {
-        "type": { "enum": ["github", "gitlab", "twitter", "x", "discord", "custom"] },
-        "url": { "type": "string", "format": "uri" },
-        "label": { "type": "string" },
-        "icon": { "type": "string" }
-      }
-    },
-    "source": {
-      "oneOf": [
-        {
-          "type": "object",
-          "additionalProperties": false,
-          "required": ["type", "repo"],
-          "properties": {
-            "type": { "const": "github" },
-            "repo": { "type": "string", "pattern": "^[^/\\s]+/[^/\\s]+$" },
-            "branch": { "type": "string", "minLength": 1 },
-            "docsDir": { "type": "string" },
-            "token": { "type": "string" },
-            "baseUrl": { "type": "string", "format": "uri" }
-          }
-        },
-        {
-          "type": "object",
-          "additionalProperties": false,
-          "required": ["type", "repo"],
-          "properties": {
-            "type": { "const": "gitlab" },
-            "repo": { "type": "string", "pattern": "^[^/\\s]+/[^/\\s]+$" },
-            "branch": { "type": "string", "minLength": 1 },
-            "docsDir": { "type": "string" },
-            "token": { "type": "string" },
-            "baseUrl": { "type": "string", "format": "uri" }
-          }
-        },
-        {
-          "type": "object",
-          "additionalProperties": false,
-          "required": ["type", "baseUrl"],
-          "properties": {
-            "type": { "const": "raw" },
-            "baseUrl": { "type": "string", "format": "uri" },
-            "branch": { "type": "string", "minLength": 1 },
-            "docsDir": { "type": "string" },
-            "token": { "type": "string" }
-          }
-        }
-      ]
-    },
-    "theme": {
-      "type": "object",
-      "additionalProperties": false,
-      "properties": {
-        "family": {
-          "enum": ["atlas", "blueprint", "terminal", "editorial"],
-          "description": "Complete visual system controlling canvas, geometry, typography rhythm and motion."
-        },
-        "density": { "enum": ["comfortable", "compact"], "description": "Reading density across shell panels." },
-        "preset": {
-          "enum": ["indigo", "emerald", "sunset", "violet", "rose", "slate", "cyberpunk"],
-          "deprecated": true,
-          "description": "Legacy accent preset. Mapped automatically onto theme.family; use family instead."
-        },
-        "defaultMode": { "enum": ["light", "dark", "auto"] },
-        "accentColor": { "type": "string" },
-        "accentColorDark": { "type": "string" },
-        "fontFamily": { "type": "string" },
-        "codeTheme": { "enum": ["github", "dracula", "one-dark", "synthwave"] },
-        "favicon": { "type": "string" },
-        "logo": {
-          "type": "object",
-          "additionalProperties": false,
-          "properties": {
-            "light": { "type": "string" },
-            "dark": { "type": "string" },
-            "alt": { "type": "string" },
-            "text": { "type": "string" }
-          }
-        }
-      }
-    },
-    "autoIndex": {
-      "type": "object",
-      "additionalProperties": false,
-      "properties": {
-        "enabled": { "type": "boolean" },
-        "exclude": { "type": "array", "items": { "type": "string", "minLength": 1 } },
-        "sort": { "enum": ["alphabetical", "frontmatter", "natural"] },
-        "defaultCollapsed": { "type": "boolean" }
-      }
-    },
-    "search": {
-      "type": "object",
-      "additionalProperties": false,
-      "properties": {
-        "enabled": { "type": "boolean" },
-        "placeholder": { "type": "string" },
-        "maxResults": { "type": "integer", "minimum": 1, "maximum": 100 }
-      }
-    },
-    "offline": {
-      "type": "object",
-      "additionalProperties": false,
-      "properties": {
-        "embedNestedDocs": {
-          "type": "boolean",
-          "description": "Embed nested documentation sites into the single-file offline bundle so no external files are needed. Defaults to true; when false, links to other documentation files render as disabled links offline."
-        }
-      }
-    },
-    "footer": {
-      "type": "object",
-      "additionalProperties": false,
-      "properties": {
-        "copyright": { "type": "string" },
-        "links": { "type": "array", "items": { "$ref": "#/$defs/navLink" } },
-        "showBuiltWith": { "type": "boolean" }
-      }
-    },
-    "sidebarItem": {
-      "type": "object",
-      "additionalProperties": false,
-      "properties": {
-        "title": { "type": "string" },
-        "path": { "type": "string" },
-        "slug": { "type": "string" },
-        "icon": { "type": "string" },
-        "badge": { "type": "string" },
-        "badgeType": { "enum": ["info", "success", "warning", "new"] },
-        "collapsed": { "type": "boolean" },
-        "children": { "type": "array", "items": { "$ref": "#/$defs/sidebarItem" } }
-      }
-    }
-  }
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/gabrielmsilva00/docmedown/main/schemas/docs.schema.json",
+  "title": "DocMeDown documentation configuration",
+  "description": "Configuration for a DocMeDown documentation root. A directory containing docs.json is an independent documentation site.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "$schema": { "type": "string", "format": "uri" },
+    "name": { "type": "string", "minLength": 1 },
+    "tagline": { "type": "string" },
+    "description": { "type": "string" },
+    "url": {
+      "type": "string",
+      "format": "uri",
+      "description": "Canonical site origin (e.g. https://docs.example.com). Enables sitemap.xml, robots.txt, canonical links, and absolute Open Graph URLs."
+    },
+    "version": { "type": "string" },
+    "rootDoc": { "type": "string", "minLength": 1 },
+    "home": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Documentation home document (path or slug) or an explicit link. Defaults to README.md, PROJECT.md, ABOUT.md, or INDEX.md at the documentation root (case-sensitive pass first, then case-insensitive), then the alphabetically first Markdown document."
+    },
+    "source": { "$ref": "#/$defs/source" },
+    "theme": { "$ref": "#/$defs/theme" },
+    "nav": { "type": "array", "items": { "$ref": "#/$defs/navLink" } },
+    "socials": { "type": "array", "items": { "$ref": "#/$defs/socialLink" } },
+    "sidebar": { "type": "array", "items": { "$ref": "#/$defs/sidebarItem" } },
+    "autoIndex": { "$ref": "#/$defs/autoIndex" },
+    "search": { "$ref": "#/$defs/search" },
+    "offline": { "$ref": "#/$defs/offline" },
+    "footer": { "$ref": "#/$defs/footer" },
+    "componentsUrl": { "type": "string" },
+    "editUrl": { "type": "string" }
+  },
+  "$defs": {
+    "navLink": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["label", "href"],
+      "properties": {
+        "label": { "type": "string", "minLength": 1 },
+        "href": { "type": "string", "minLength": 1 },
+        "external": { "type": "boolean" },
+        "icon": { "type": "string" }
+      }
+    },
+    "socialLink": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "url"],
+      "properties": {
+        "type": { "enum": ["github", "gitlab", "twitter", "x", "discord", "custom"] },
+        "url": { "type": "string", "format": "uri" },
+        "label": { "type": "string" },
+        "icon": { "type": "string" }
+      }
+    },
+    "source": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["type", "repo"],
+          "properties": {
+            "type": { "const": "github" },
+            "repo": { "type": "string", "pattern": "^[^/\\s]+/[^/\\s]+$" },
+            "branch": { "type": "string", "minLength": 1 },
+            "docsDir": { "type": "string" },
+            "token": { "type": "string" },
+            "baseUrl": { "type": "string", "format": "uri" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["type", "repo"],
+          "properties": {
+            "type": { "const": "gitlab" },
+            "repo": { "type": "string", "pattern": "^[^/\\s]+/[^/\\s]+$" },
+            "branch": { "type": "string", "minLength": 1 },
+            "docsDir": { "type": "string" },
+            "token": { "type": "string" },
+            "baseUrl": { "type": "string", "format": "uri" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["type", "baseUrl"],
+          "properties": {
+            "type": { "const": "raw" },
+            "baseUrl": { "type": "string", "format": "uri" },
+            "branch": { "type": "string", "minLength": 1 },
+            "docsDir": { "type": "string" },
+            "token": { "type": "string" }
+          }
+        }
+      ]
+    },
+    "theme": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "family": {
+          "enum": ["atlas", "blueprint", "terminal", "editorial"],
+          "description": "Complete visual system controlling canvas, geometry, typography rhythm and motion."
+        },
+        "density": { "enum": ["comfortable", "compact"], "description": "Reading density across shell panels." },
+        "preset": {
+          "enum": ["indigo", "emerald", "sunset", "violet", "rose", "slate", "cyberpunk"],
+          "deprecated": true,
+          "description": "Legacy accent preset. Mapped automatically onto theme.family; use family instead."
+        },
+        "defaultMode": { "enum": ["light", "dark", "auto"] },
+        "accentColor": { "type": "string" },
+        "accentColorDark": { "type": "string" },
+        "fontFamily": { "type": "string" },
+        "codeTheme": { "enum": ["github", "dracula", "one-dark", "synthwave"] },
+        "favicon": { "type": "string" },
+        "logo": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "light": { "type": "string" },
+            "dark": { "type": "string" },
+            "alt": { "type": "string" },
+            "text": { "type": "string" }
+          }
+        }
+      }
+    },
+    "autoIndex": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "exclude": { "type": "array", "items": { "type": "string", "minLength": 1 } },
+        "sort": { "enum": ["alphabetical", "frontmatter", "natural"] },
+        "defaultCollapsed": { "type": "boolean" }
+      }
+    },
+    "search": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "placeholder": { "type": "string" },
+        "maxResults": { "type": "integer", "minimum": 1, "maximum": 100 }
+      }
+    },
+    "offline": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "embedNestedDocs": {
+          "type": "boolean",
+          "description": "Embed nested documentation sites into the single-file offline bundle so no external files are needed. Defaults to true; when false, links to other documentation files render as disabled links offline."
+        }
+      }
+    },
+    "footer": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "copyright": { "type": "string" },
+        "links": { "type": "array", "items": { "$ref": "#/$defs/navLink" } },
+        "showBuiltWith": { "type": "boolean" }
+      }
+    },
+    "sidebarItem": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "title": { "type": "string" },
+        "path": { "type": "string" },
+        "slug": { "type": "string" },
+        "icon": { "type": "string" },
+        "badge": { "type": "string" },
+        "badgeType": { "enum": ["info", "success", "warning", "new"] },
+        "collapsed": { "type": "boolean" },
+        "children": { "type": "array", "items": { "$ref": "#/$defs/sidebarItem" } }
+      }
+    }
+  }
 }

package/templates/.dmd/CounterWidget.svelte

@@ -0,0 +1,29 @@
+<svelte:options customElement={{ tag: "dmd-counter-widget" }} />
+<script lang="ts">
+  let { title = "Interactive Counter" }: { title?: string } = $props();
+  let count = $state(0);
+</script>
+
+<div class="dmd-counter-panel">
+  <button type="button" class="dmd-counter-btn" onclick={() => count++}>
+    {title}: {count}
+  </button>
+</div>
+
+<style>
+  :host {
+    display: block;
+  }
+  .dmd-counter-panel {
+    margin: 1rem 0;
+  }
+  .dmd-counter-btn {
+    padding: 0.55rem 0.85rem;
+    border: 1px solid var(--dmd-accent);
+    border-radius: 6px;
+    background: var(--dmd-accent-subtle);
+    color: var(--dmd-text-primary);
+    cursor: pointer;
+    font-weight: 700;
+  }
+</style>

package/templates/README.md

@@ -20,7 +20,7 @@ tags: [getting-started, overview, docs]
 - **🚀 Zero Build Friction**: Host statically, build a self-contained `.dist/index.html` for `file:///`, or document remote GitHub/GitLab repositories dynamically.
 - **🎨 Complete Theme Families**: Atlas, Blueprint, Terminal, and Editorial each provide distinct surfaces, geometry, typography, spacing, and diagram palettes across light and dark modes.
 - **⚡ Fast Search**: In-browser fuzzy search with `⌘K` command palette.
-- **⚛️ React Components**: Support for custom React components via `.dmd/` global registry or ready-to-use builtins.
+- **🧩 Custom Components**: Support for custom `.dmd/` widgets written in native Svelte 5, React TSX, or Web Elements, plus ready-to-use builtins.
 - **📊 Diagrams & Math**: A theme-aware Mermaid viewer with Fit, zoom, SVG export, and offline parity, plus KaTeX formulas.
 
 ---
@@ -30,7 +30,7 @@ tags: [getting-started, overview, docs]
 ```mermaid
 graph LR
     A[Markdown Files] --> B[DocMeDown Parser]
-    B --> C[React SPA Runtime]
+    B --> C[Svelte 5 Engine]
     C --> D[Live Documentation Site]
     E[docs.json] --> C
     F[.dmd Components] --> C

package/templates/favicon.svg

@@ -0,0 +1,12 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32">
+  <defs>
+    <linearGradient id="dmd-fav-bg" x1="0%" y1="0%" x2="100%" y2="100%">
+      <stop offset="0%" stop-color="#4f46e5"/>
+      <stop offset="100%" stop-color="#7c3aed"/>
+    </linearGradient>
+  </defs>
+  <rect width="32" height="32" rx="7" fill="url(#dmd-fav-bg)"/>
+  <path d="M9 5h8.5l6.5 6.5V25a2 2 0 0 1-2 2H9a2 2 0 0 1-2-2V7a2 2 0 0 1 2-2Z" fill="#ffffff" fill-opacity="0.16" stroke="#ffffff" stroke-width="1.8" stroke-linejoin="round"/>
+  <path d="M17.5 5v5a1.5 1.5 0 0 0 1.5 1.5h5" stroke="#ffffff" stroke-width="1.8" stroke-linecap="round" stroke-linejoin="round" fill="none"/>
+  <path d="M16 12.5v9.5m-3.5-3.5 3.5 3.5 3.5-3.5" stroke="#ffffff" stroke-width="2.2" stroke-linecap="round" stroke-linejoin="round"/>
+</svg>

package/templates/favicons/favicon-book.svg

@@ -0,0 +1,11 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32">
+  <defs>
+    <linearGradient id="dmd-fav-book" x1="0%" y1="0%" x2="100%" y2="100%">
+      <stop offset="0%" stop-color="#2563eb"/>
+      <stop offset="100%" stop-color="#1d4ed8"/>
+    </linearGradient>
+  </defs>
+  <rect width="32" height="32" rx="7" fill="url(#dmd-fav-book)"/>
+  <path d="M16 11.5c-2.8-1.8-6.5-1.8-9.5 0v11c3-1.4 6.7-1.4 9.5 0m0-11c2.8-1.8 6.5-1.8 9.5 0v11c-3-1.4-6.7-1.4-9.5 0M16 11.5v11" fill="none" stroke="#ffffff" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
+  <path d="M16 7.5v2.5" stroke="#93c5fd" stroke-width="2" stroke-linecap="round"/>
+</svg>

package/templates/favicons/favicon-markdown.svg

@@ -0,0 +1,11 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32">
+  <defs>
+    <linearGradient id="dmd-fav-md" x1="0%" y1="0%" x2="100%" y2="100%">
+      <stop offset="0%" stop-color="#1e293b"/>
+      <stop offset="100%" stop-color="#0f172a"/>
+    </linearGradient>
+  </defs>
+  <rect width="32" height="32" rx="7" fill="url(#dmd-fav-md)" stroke="#38bdf8" stroke-width="1.2" stroke-opacity="0.35"/>
+  <path d="M6.5 21V11h3l3 4.5 3-4.5h3v10" fill="none" stroke="#f8fafc" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
+  <path d="M22.5 11v10m-3-3 3 3 3-3" fill="none" stroke="#38bdf8" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
+</svg>

package/templates/favicons/favicon-minimal.svg

@@ -0,0 +1,15 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32">
+  <defs>
+    <linearGradient id="dmd-fav-min-bg" x1="0%" y1="0%" x2="100%" y2="100%">
+      <stop offset="0%" stop-color="#18181b"/>
+      <stop offset="100%" stop-color="#09090b"/>
+    </linearGradient>
+    <linearGradient id="dmd-fav-min-accent" x1="0%" y1="0%" x2="100%" y2="100%">
+      <stop offset="0%" stop-color="#38bdf8"/>
+      <stop offset="100%" stop-color="#818cf8"/>
+    </linearGradient>
+  </defs>
+  <rect width="32" height="32" rx="7" fill="url(#dmd-fav-min-bg)" stroke="#27272a" stroke-width="1.2"/>
+  <polygon points="16,6 25,11.2 25,20.8 16,26 7,20.8 7,11.2" fill="none" stroke="url(#dmd-fav-min-accent)" stroke-width="2" stroke-linejoin="round"/>
+  <circle cx="16" cy="16" r="3.5" fill="url(#dmd-fav-min-accent)"/>
+</svg>

package/templates/favicons/favicon-terminal.svg

@@ -0,0 +1,14 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32">
+  <defs>
+    <linearGradient id="dmd-fav-term" x1="0%" y1="0%" x2="100%" y2="100%">
+      <stop offset="0%" stop-color="#0f172a"/>
+      <stop offset="100%" stop-color="#020617"/>
+    </linearGradient>
+  </defs>
+  <rect width="32" height="32" rx="7" fill="url(#dmd-fav-term)" stroke="#10b981" stroke-width="1.2" stroke-opacity="0.4"/>
+  <circle cx="8" cy="8" r="1.5" fill="#ef4444" opacity="0.85"/>
+  <circle cx="12.5" cy="8" r="1.5" fill="#f59e0b" opacity="0.85"/>
+  <circle cx="17" cy="8" r="1.5" fill="#10b981" opacity="0.85"/>
+  <path d="M8.5 15.5l5 4-5 4" fill="none" stroke="#10b981" stroke-width="2.2" stroke-linecap="round" stroke-linejoin="round"/>
+  <line x1="16.5" y1="23.5" x2="23.5" y2="23.5" stroke="#38bdf8" stroke-width="2.2" stroke-linecap="round"/>
+</svg>

package/templates/favicons/favicon.svg

@@ -0,0 +1,12 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32">
+  <defs>
+    <linearGradient id="dmd-fav-bg" x1="0%" y1="0%" x2="100%" y2="100%">
+      <stop offset="0%" stop-color="#4f46e5"/>
+      <stop offset="100%" stop-color="#7c3aed"/>
+    </linearGradient>
+  </defs>
+  <rect width="32" height="32" rx="7" fill="url(#dmd-fav-bg)"/>
+  <path d="M9 5h8.5l6.5 6.5V25a2 2 0 0 1-2 2H9a2 2 0 0 1-2-2V7a2 2 0 0 1 2-2Z" fill="#ffffff" fill-opacity="0.16" stroke="#ffffff" stroke-width="1.8" stroke-linejoin="round"/>
+  <path d="M17.5 5v5a1.5 1.5 0 0 0 1.5 1.5h5" stroke="#ffffff" stroke-width="1.8" stroke-linecap="round" stroke-linejoin="round" fill="none"/>
+  <path d="M16 12.5v9.5m-3.5-3.5 3.5 3.5 3.5-3.5" stroke="#ffffff" stroke-width="2.2" stroke-linecap="round" stroke-linejoin="round"/>
+</svg>