docmedown 0.1.0 → 0.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docmedown",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "The simplest MarkDown documenter yet. CLI & Web Script React SPA documentation engine.",
   "main": "./dist/docmedown.cjs",
   "module": "./dist/docmedown.mjs",
@@ -23,6 +23,7 @@
     "dist",
     "bin",
     "templates",
+    "schemas",
     "README.md",
     "LICENSE"
   ],
@@ -31,6 +32,9 @@
     "build:runtime": "vite build",
     "build:cli": "tsup",
     "typecheck": "tsc --noEmit",
+    "lint": "biome check .",
+    "lint:fix": "biome check --write .",
+    "format": "biome format --write .",
     "build:types": "tsc -p tsconfig.runtime.json",
     "build": "npm run build:runtime && npm run build:cli && npm run build:types",
     "docmedown": "node ./bin/docmedown.js",
@@ -42,8 +46,11 @@
     "build:docs:watch": "node ./bin/docmedown.js build ./docs --watch",
     "build:offline": "node ./bin/docmedown.js build ./docs",
     "config:docs": "node ./bin/docmedown.js config ./docs/docs.json",
-    "test": "npx tsx --test tests/parser.test.ts tests/scanner.test.ts tests/runtime-integration.test.ts tests/package-smoke.test.ts",
-    "test:release": "npm run typecheck && npm run test && npm run build && npm run build:docs && npm pack --dry-run",
+    "test": "npx tsx --test tests/parser.test.ts tests/scanner.test.ts tests/theme-schema.test.ts tests/runtime-integration.test.ts tests/package-smoke.test.ts tests/hosting.test.ts",
+    "test:artifacts": "npx tsx --test tests/offline-artifact.test.ts",
+    "test:release": "npm run typecheck && npm run lint && npm run test && npm run build && npm run build:docs && npm run test:artifacts && npm pack --dry-run",
+    "deploy": "node ./scripts/deploy.mjs",
+    "deploy:dry-run": "npm run deploy -- --dry-run",
     "prepublishOnly": "npm run test:release"
   },
   "keywords": [
@@ -81,13 +88,16 @@
     "chalk": "^4.1.2",
     "chokidar": "^3.6.0",
     "commander": "^12.1.0",
+    "esbuild": "^0.28.2",
     "gray-matter": "^4.0.3",
     "mime-types": "^2.1.35",
     "open": "^10.1.0",
     "prompts": "^2.4.2",
-    "ws": "^8.18.0"
+    "ws": "^8.18.0",
+    "zod": "^4.4.3"
   },
   "devDependencies": {
+    "@biomejs/biome": "^2.5.10",
     "@types/node": "^22.5.0",
     "@types/prismjs": "^1.26.6",
     "@types/prompts": "^2.4.9",
@@ -97,6 +107,7 @@
     "@vitejs/plugin-react": "^6.1.0",
     "katex": "^0.16.11",
     "marked": "^14.1.1",
+    "mermaid": "^11.17.2",
     "minisearch": "^7.1.0",
     "prismjs": "^1.29.0",
     "react": "^18.3.1",

package/schemas/docs.schema.json

@@ -0,0 +1,166 @@
+{
+  "$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 },
+    "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" },
+    "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 }
+      }
+    },
+    "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/README.md

@@ -17,11 +17,11 @@ tags: [getting-started, overview, docs]
 
 ## Key Features
 
-- **🚀 Zero Build Friction**: Host statically, view locally offline (`file:///`), or document remote GitHub/GitLab repositories dynamically.
-- **🎨 Glassmorphic Themes**: Sleek Dark & Light modes with multiple vibrant color presets (Indigo, Emerald, Sunset, Violet, Rose, Slate, Cyberpunk).
+- **🚀 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.
-- **📊 Diagrams & Math**: Native support for **Mermaid.js** diagrams and **KaTeX** math formulas.
+- **📊 Diagrams & Math**: A theme-aware Mermaid viewer with Fit, zoom, SVG export, and offline parity, plus KaTeX formulas.
 
 ---
 
@@ -46,7 +46,7 @@ graph LR
 > This is a standard informative note callout.
 
 > [!IMPORTANT]
-> Important guidelines or critical notices appear with highlighted violet accents.
+> Important guidelines or critical notices use the active family's semantic emphasis colors.
 
 > [!WARNING]
 > Warnings help developers avoid common pitfalls and mistakes.

package/templates/docs.json

@@ -1,12 +1,15 @@
 {
+  "$schema": "https://raw.githubusercontent.com/gabrielmsilva00/docmedown/main/schemas/docs.schema.json",
   "name": "My Project Docs",
   "tagline": "The simplest Markdown documentation yet",
   "description": "Fast, modern documentation created with DocMeDown",
   "version": "1.0.0",
   "rootDoc": "README.md",
   "theme": {
-    "preset": "indigo",
-    "defaultMode": "auto"
+    "family": "atlas",
+    "density": "comfortable",
+    "defaultMode": "auto",
+    "codeTheme": "github"
   },
   "nav": [
     { "label": "Overview", "href": "#/README" },

package/templates/getting-started.md

@@ -25,7 +25,7 @@ This scaffolds your documentation directory, creates starter Markdown guides, an
 
 ## 2. Interactive Configuration TUI
 
-Need to customize your site title, theme palette, or configure a remote GitHub repository? Launch the interactive TUI configuration wizard:
+Need to customize your site title, theme family, color mode, or configure a remote GitHub repository? Launch the interactive TUI configuration wizard:
 
 ```bash
 npx docmedown config

package/templates/guides/custom-components.md

@@ -32,6 +32,8 @@ export default {
 };
 ```
 
+`docmedown build` bundles this module and its relative JavaScript imports into both `_docs.js` and `.dist/index.html`, so the same component behavior works from a static host and `file:///` offline bundle.
+
 ---
 
 ## 2. Using Custom and Built-in Components

package/templates/index.html

@@ -3,10 +3,8 @@
 <head>
   <meta charset="UTF-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <link rel="icon" href="data:," />
   <title>DocMeDown Documentation</title>
-  <link rel="preconnect" href="https://fonts.googleapis.com" />
-  <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
-  <link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700;800&family=JetBrains+Mono:wght@400;500;600&display=swap" rel="stylesheet" />
 </head>
 <body>
   <div id="dmd-app"></div>
@@ -14,6 +12,6 @@
   <!-- Pre-compiled docs data (enables 100% offline file:/// double-click viewing without web server) -->
   <script src="./_docs.js"></script>
   <!-- DocMeDown Runtime Script -->
-  <script src="./docmedown.iife.js"></script>
+  <script src="./docmedown.iife.js" data-docmedown-runtime></script>
 </body>
 </html>