docmedown 0.1.7 → 0.9.0

package/LICENSE

@@ -1,21 +1,201 @@
-MIT License
-
-Copyright (c) 2026 Gabriel M. Silva
-
-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.
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Gabriel M. P. da Silva and contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -2,7 +2,7 @@
 ### *The simplest MarkDown documenter yet.*
 
 [![npm version](https://img.shields.io/npm/v/docmedown.svg?style=flat-square&color=6366f1)](https://www.npmjs.com/package/docmedown)
-[![License: MIT](https://img.shields.io/badge/License-MIT-emerald.svg?style=flat-square)](https://opensource.org/licenses/MIT)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg?style=flat-square)](https://opensource.org/licenses/Apache-2.0)
 [![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg?style=flat-square)](https://www.typescriptlang.org/)
 [![CI](https://github.com/gabrielmsilva00/docmedown/actions/workflows/ci.yml/badge.svg)](https://github.com/gabrielmsilva00/docmedown/actions/workflows/ci.yml)
 
@@ -19,15 +19,21 @@ Drop a single `index.html` file into any directory of `.md` files, and you have
 - 🚀 **Zero-Config Auto-Discovery**: Automatically parses and indexes all `.md` files & subfolders into categories, builds navigation sidebars, and powers instant search out of the box.
 - 🌐 **Dual Usage: CLI Tool & Web Script**:
   - Run via single-line CLI: `npx docmedown ./docs`
-  - Or drop `<script src="docmedown.js"></script>` into an `index.html` on any static host.
+  - Or drop `<script src="https://cdn.jsdelivr.net/npm/docmedown@latest/dist/docmedown.iife.js"></script>` into an `index.html` on any static host.
+- ✍️ **2-Way In-Browser Editor & Live HMR**: Press `Ctrl+E` / `⌘E` to edit documents in a split-view editor modal with live keystroke rendering, instant disk save, zero-page-reload WebSocket HMR, and staged preview support (`--preview`).
 - ⚡ **Dynamic Remote GitHub / GitLab Mode**: Document any GitHub or GitLab repository *live* without hosting markdown files statically! Changes pushed to your repo dynamically update the documentation website immediately.
 - 📦 **Compressed Offline Copies**: Generate or download a minified, self-extracting `index.html` containing the complete documentation corpus, custom components, Mermaid renderer, styles, and runtime. Double-click it under `file:///` without a web server.
-- 🎨 **Four Complete Theme Families**: Atlas, Blueprint, Terminal, and Editorial each redefine surfaces, geometry, typography, spacing, and diagram palettes—not merely the accent color. Every family supports light, dark, automatic mode, and comfortable or compact density.
+- 🎨 **Four Complete Theme Families & Favicon Presets**: Atlas, Blueprint, Terminal, and Editorial each redefine surfaces, geometry, typography, spacing, and diagram palettes. Choose from 5 crisp SVG favicon presets with automatic offline inlining.
+- 📊 **Interactive Data Tables & Delimited Text Toolbar**: Fenced `csv`, `tsv`, and standard GFM tables automatically render as interactive data tables with column/row descriptors and one-click copy export (Markdown, HTML, CSV).
+- 🌐 **Static + SEO Output**: every build prerenders complete static pages per document with canonical URLs, Open Graph, Twitter cards, JSON-LD structured data, `sitemap.xml`, and `robots.txt` — crawlers see everything, no JS required.
+- 🤖 **AI-Native Distribution**: auto-generated `llms.txt` / `llms-full.txt` / `SKILL.md` / `okf.json`, plus a built-in MCP server (`docmedown mcp`) so Claude, Cursor, and Windsurf can read and search your docs directly.
 - 🔍 **Instant Fuzzy Search**: Keyboard-driven command palette (`⌘K` / `Ctrl+K`) with real-time in-browser indexing.
-- ⚛️ **React Custom Components (.dmd)**: Support for custom React components inside `.dmd/` or built-in components (`<Tabs>`, `<CardGrid>`, `<Badge>`, `<Steps>`).
+- 🧩 **Multi-Framework Custom Components (.dmd)**: Author custom components in **native Svelte 5**, **React TSX**, or **Web Elements (Lit)** inside `.dmd/`, plus built-in components (`<Tabs>`, `<CardGrid>`, `<Media>`, `<Badge>`, `<Steps>`).
+- 🩺 **Built-in CLI Doctor & Link Validator**: Run `docmedown doctor` and `docmedown validate` for automated environment diagnostics, missing asset detection, ahead-of-time component verification, and deep link/anchor integrity.
 - 📊 **Mermaid Diagrams & KaTeX Math**: Theme-aware diagrams with automatic Fit, zoom, 1:1 view, SVG export, expanded review, and offline parity, plus native LaTeX equations.
 - 💡 **GitHub-Style Callouts**: Full support for `[!NOTE]`, `[!TIP]`, `[!IMPORTANT]`, `[!WARNING]`, and `[!CAUTION]`.
 
+
 ---
 
 ## 🚀 10-Second Quickstart
@@ -158,7 +164,7 @@ Within this repository, the equivalent command is `npm run build:docs:watch`.
 
 ## 🚢 GitHub Pages Hosting
 
-The repository includes `.github/workflows/pages.yml`, which builds the production runtime and generated documentation assets before publishing `./docs/` through GitHub Pages. This is required because `_docs.js`, `_manifest.json`, and `docmedown.iife.js` are generated files and intentionally ignored by Git.
+The repository includes `.github/workflows/pages.yml`, which builds the production runtime and generated documentation assets before publishing `./docs/` through GitHub Pages. This is required because `_docs.js`, `_manifest.json`, and `docmedown.web.js` are generated files and intentionally ignored by Git.
 
 To enable it for a repository fork or project site:
 
@@ -166,34 +172,50 @@ To enable it for a repository fork or project site:
 2. In **Settings → Pages**, set the source to **GitHub Actions**.
 3. Push documentation or runtime changes; the workflow runs `npm ci`, `npm run build`, and `npm run build:docs`, then uploads the complete `docs/` directory.
 
-The generated entrypoint uses same-directory relative URLs (`./_docs.js` and `./docmedown.iife.js`), so it works at both a custom domain and a project URL such as `/repository-name/`. The Pages workflow verifies those generated files before upload and includes `.nojekyll` for direct static-file compatibility. Hash routing keeps document navigation client-side without requiring server rewrites.
+The generated entrypoint uses same-directory relative URLs (`./_docs.js` and `./docmedown.web.js`), so it works at both a custom domain and a project URL such as `/repository-name/`. The Pages workflow verifies those generated files before upload and includes `.nojekyll` for direct static-file compatibility. Hash routing keeps document navigation client-side without requiring server rewrites.
 
 ---
 
-## ⚛️ Custom React Components (.dmd)
+## 🧩 Custom Components (.dmd)
+
+DocMeDown provides a **Universal Component Compatibility Layer**. You can author custom widgets in **native Svelte 5**, **React with TypeScript (TSX)**, or standard **Web Elements (Lit)** with zero build setup:
+
+### 1. Svelte 5 Component (`.dmd/CounterWidget.svelte`)
+
+```svelte title=".dmd/CounterWidget.svelte"
+<script>
+  let { title = "Interactive Counter" } = $props();
+  let count = $state(0);
+</script>
+
+<div class="counter-widget">
+  <strong>{title}: {count}</strong>
+  <button onclick={() => count++}>+1</button>
+</div>
+```
 
-Define global React components in a browser-loadable `.dmd/components.js` module. React is available as `window.React` in that module:
+### 2. React TSX Component (`.dmd/ReactMetricCard.tsx`)
 
-```js title=".dmd/components.js"
-const { createElement, useState } = window.React;
+```tsx title=".dmd/ReactMetricCard.tsx"
+import React, { useState } from "react";
 
-export function CounterButton() {
-  const [count, setCount] = useState(0);
-  return createElement(
-    'button',
-    { onClick: () => setCount((value) => value + 1) },
-    `Clicked ${count} times`
+export default function ReactMetricCard({ label = "Query Rate", initial = 100 }) {
+  const [val, setVal] = useState(initial);
+  return (
+    <div className="metric-panel">
+      <strong>{label}: {val} req/s</strong>
+      <button onClick={() => setVal(val + 10)}>Boost</button>
+    </div>
   );
 }
-
-export default {
-  CounterButton,
-};
 ```
 
-You can now use `<CounterButton />` anywhere inside your Markdown documents!
+Use `<CounterWidget />` or `<ReactMetricCard />` directly inside any Markdown document!
 
-The standard build embeds `.dmd/components.js` in `docs/.dist/index.html`, so the same custom components work in the distributable offline bundle.
+- **Build-Time AOT Compilation**: Standard React TSX components are compiled Ahead-of-Time into native Svelte 5 custom elements during `docmedown build`, eliminating React runtime overhead.
+- **Runtime Bridge Fallback**: Complex React components mount cleanly via `ReactBridge` (`createRoot`), preserving hook fidelity.
+- **Offline Parity**: All `.dmd/` components are pre-compiled and embedded in `./docs/.dist/index.html` for 100% self-contained offline functionality.
+- **Legacy Compatibility**: Standard `.dmd/components.js` custom element modules remain fully supported.
 
 ### Ready-to-Use Built-in Markdown Components
 
@@ -283,24 +305,23 @@ Use the **Appearance** menu to switch family, color mode, and reading density at
 ---
 
 ## 🛠️ CLI Command Reference
-
+ 
 | Command | Description |
 | :--- | :--- |
 | `docmedown [dir]` | Auto-initializes if empty, or starts local preview server |
 | `docmedown init [dir]` | Scaffolds starter docs, `index.html`, `docs.json`, and `.dmd` folder |
-| `docmedown serve [dir]` (or `dev`) | Starts local live-reloading dev server on `http://localhost:3000` |
-| `docmedown build [dir]` | Builds serveable files and `./<dir>/.dist/index.html` for offline use |
+| `docmedown serve [dir]` (or `dev`) | Starts local live-reloading dev server with WebSocket HMR and in-browser editor (`Ctrl+E`) |
+| `docmedown serve [dir] --preview` | Starts dev server in staged `.preview/` overlay mode |
+| `docmedown build [dir]` | Builds serveable files, prerendered static pages with SEO metadata, AI context files (`llms.txt`, `llms-full.txt`, `SKILL.md`, `okf.json`), and `./<dir>/.dist/index.html` for offline use |
 | `docmedown build [dir] --no-single-file` | Builds serveable files only |
+| `docmedown build [dir] --no-static` | Skips static page prerendering and SEO/AI context files |
+| `docmedown mcp [dir]` | Serves documentation as an MCP (Model Context Protocol) server over stdio or SSE |
+| `docmedown validate [dir]` | Validates Markdown links, anchors, frontmatter, and `docs.json` schema |
+| `docmedown doctor [dir]` | Diagnoses Node environment, missing assets, and `.dmd` component compilation |
 | `docmedown config [path]` | Launches interactive TUI configuration wizard |
 
 ---
 
-## 📄 License
-
-MIT © DocMeDown Contributors
-
----
-
 ## 🚀 Maintainer release command
 
 Maintainers publish a prepared version with one command:
@@ -311,16 +332,44 @@ npm run deploy
 
 It validates the release, pushes `main` and `v<version>` to GitHub, publishes to npm, and verifies the npm registry. Run `npm run deploy:dry-run` to validate without changing GitHub or npm.
 
-## 🧹 Quality checks
+## 🧹 Quality checks & local MCP testing
 
 DocMeDown uses [Biome](https://biomejs.dev/) for formatting, import organization, and linting, and Zod for runtime configuration validation.
 
 ```bash
-npm run lint       # check formatting, imports, and lint rules
-npm run lint:fix   # apply Biome fixes
-npm run format     # format maintained source files
-npm run typecheck
-npm test
+npm run lint          # check formatting, imports, and lint rules
+npm run lint:fix      # apply Biome fixes
+npm run format        # format maintained source files
+npm run typecheck     # static type analysis
+npm test              # full unit test suite
+npm run test:mcp      # dedicated MCP protocol test suite
+npm run dev:mcp       # launch local MCP server over stdio
+npm run test:mcp:client # test MCP queries interactively from CLI
 ```
 
 `npm run test:release` runs all of these checks plus production, documentation, and package smoke builds.
+
+---
+
+## 📄 License
+
+DocMeDown is open-source software licensed under the [Apache License, Version 2.0](LICENSE).
+
+Copyright © 2026 Gabriel M. P. da Silva and DocMeDown Contributors.
+
+### Rationale for Apache License 2.0
+
+DocMeDown is licensed under the **Apache License, Version 2.0**. While both MIT and Apache 2.0 are permissive open-source licenses granting full freedom to use, modify, distribute, and commercialize the software, Apache 2.0 provides key legal and practical advantages:
+
+1. **Explicit Patent License Grant (Section 3)**:
+   MIT provides a general copyright license but does not explicitly address software patents. Apache 2.0 includes an express, royalty-free, perpetual patent license granted by all contributors to any user, eliminating legal ambiguity and providing total confidence when adopting DocMeDown in enterprise environments.
+
+2. **Defensive Patent Retaliation**:
+   Apache 2.0 contains a mutual termination clause: if an entity files a patent infringement lawsuit against the project or its users claiming the work infringes their patents, any patent licenses granted to that entity under Apache 2.0 are automatically terminated. This prevents predatory patent litigation and protects the community.
+
+3. **Trademark Protection (Section 6)**:
+   Apache 2.0 explicitly clarifies that the license does not grant trademark rights to use the project’s name, logo, or branding without permission, preventing malicious or misleading impersonation of DocMeDown while keeping the code 100% open.
+
+4. **Contributor Clarity & Enterprise Adoption**:
+   Apache 2.0 standardizes intellectual property and contribution guidelines (Sections 4 & 5). It is the recognized standard across modern developer infrastructure (such as Kubernetes, Apache Software Foundation projects, LLVM runtimes, Android, and TypeScript components), ensuring frictionless compliance for corporate legal teams and independent developers alike.
+

package/dist/architecture-7GRP2DOG-B8Xs9IfY.mjs

@@ -0,0 +1,2 @@
+import { j as e } from "./mermaid-Cx9uSfoz.mjs";
+export { e as createArchitectureServices };

package/dist/architecture-7GRP2DOG-Vdsw7WC7.js

@@ -0,0 +1 @@
+const e=require("./mermaid-BvOI3ZSW.js");exports.createArchitectureServices=e.j;