docmedown 0.1.0

package/templates/README.md

@@ -0,0 +1,68 @@
+---
+title: Welcome to DocMeDown
+description: The simplest MarkDown documenter yet.
+icon: 🚀
+order: 1
+tags: [getting-started, overview, docs]
+---
+
+# Welcome to DocMeDown ⚡
+
+**DocMeDown** is the simplest Markdown documentation system yet. Drop an `index.html` file into any folder of Markdown files, and you have a fully-featured, blazing fast documentation website.
+
+> [!TIP]
+> **Zero Configuration Required**: DocMeDown automatically indexes all your `.md` files and subfolders into categories, builds navigation, and enables instant search out of the box!
+
+---
+
+## 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).
+- **⚡ 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.
+
+---
+
+## Architecture Flow
+
+```mermaid
+graph LR
+    A[Markdown Files] --> B[DocMeDown Parser]
+    B --> C[React SPA Runtime]
+    C --> D[Live Documentation Site]
+    E[docs.json] --> C
+    F[.dmd Components] --> C
+```
+
+---
+
+## Interactive Features Demo
+
+### 1. GitHub-style Callouts
+
+> [!NOTE]
+> This is a standard informative note callout.
+
+> [!IMPORTANT]
+> Important guidelines or critical notices appear with highlighted violet accents.
+
+> [!WARNING]
+> Warnings help developers avoid common pitfalls and mistakes.
+
+---
+
+### 2. Math Formulas
+
+You can write inline math like $E = mc^2$ or block LaTeX math equations:
+
+$$
+\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}
+$$
+
+---
+
+## Next Steps
+
+Check out the [Quickstart Guide](./getting-started.md) to learn how to add your own pages and customize your site.

package/templates/docs.json

@@ -0,0 +1,25 @@
+{
+  "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"
+  },
+  "nav": [
+    { "label": "Overview", "href": "#/README" },
+    { "label": "Quickstart", "href": "#/getting-started" },
+    { "label": "Guides", "href": "#/guides/custom-components" }
+  ],
+  "autoIndex": {
+    "enabled": true,
+    "sort": "natural",
+    "defaultCollapsed": false
+  },
+  "search": {
+    "enabled": true,
+    "placeholder": "Search documentation..."
+  }
+}

package/templates/getting-started.md

@@ -0,0 +1,64 @@
+---
+title: Getting Started
+description: Quick installation and configuration guide for DocMeDown.
+order: 2
+tags: [setup, cli, quickstart]
+---
+
+# Getting Started with DocMeDown
+
+Learn how to initialize, configure, and serve your documentation in less than 30 seconds.
+
+---
+
+## 1. Quick Start via CLI
+
+You can initialize a brand new documentation site with a single command:
+
+```bash
+npx docmedown ./docs
+```
+
+This scaffolds your documentation directory, creates starter Markdown guides, and starts a live preview server!
+
+---
+
+## 2. Interactive Configuration TUI
+
+Need to customize your site title, theme palette, or configure a remote GitHub repository? Launch the interactive TUI configuration wizard:
+
+```bash
+npx docmedown config
+```
+
+---
+
+## 3. Remote GitHub Repository Mode
+
+You can document any public (or private) GitHub repository dynamically without hosting any markdown files! Simply configure `docs.json`:
+
+```json title="docs.json"
+{
+  "name": "Dynamic GitHub Docs",
+  "source": {
+    "type": "github",
+    "repo": "facebook/react",
+    "branch": "main",
+    "docsDir": "docs"
+  }
+}
+```
+
+Every push to your GitHub repo is immediately reflected on your documentation website live without rebuilds!
+
+---
+
+## 4. Single-File Offline Bundling
+
+To generate a 100% self-contained single-file HTML documentation bundle that works offline via `file:///`:
+
+```bash
+npx docmedown build ./docs
+```
+
+The standalone artifact is written to `./docs/.dist/index.html`. You can send it by email, save it to USB drives, or distribute it inside air-gapped systems.

package/templates/guides/custom-components.md

@@ -0,0 +1,78 @@
+---
+title: Custom React Components
+description: Learn how to use .dmd components and interactive widgets inside your Markdown.
+order: 1
+tags: [components, react, dmd]
+---
+
+# Custom React Components (.dmd)
+
+DocMeDown supports embedding custom React components directly into your documentation.
+
+---
+
+## 1. Defining Global Components
+
+Place a browser-loadable module at `.dmd/components.js`. DocMeDown exposes React as `window.React` inside that module:
+
+```js title=".dmd/components.js"
+const { createElement, useState } = window.React;
+
+export function InteractiveButton({ label = 'Click Me' }) {
+  const [count, setCount] = useState(0);
+  return createElement(
+    'button',
+    { onClick: () => setCount((value) => value + 1) },
+    `${label}: ${count}`
+  );
+}
+
+export default {
+  InteractiveButton,
+};
+```
+
+---
+
+## 2. Using Custom and Built-in Components
+
+DocMeDown comes with built-in interactive components ready to use:
+
+```html
+<InteractiveButton label="Count clicks" />
+```
+
+### Tabbed Code Snippets
+
+```html
+<Tabs>
+  <Tab label="npm">
+    npm install docmedown
+  </Tab>
+  <Tab label="yarn">
+    yarn add docmedown
+  </Tab>
+  <Tab label="pnpm">
+    pnpm add docmedown
+  </Tab>
+</Tabs>
+```
+
+### Feature Card Grid
+
+```html
+<CardGrid cols={2}>
+  <Card
+    title="Zero Build Friction"
+    description="Drop index.html and start browsing immediately."
+    badge="Fast"
+    badgeType="success"
+  />
+  <Card
+    title="Remote GitHub Repos"
+    description="Document remote git repositories live."
+    badge="Live"
+    badgeType="new"
+  />
+</CardGrid>
+```

package/templates/index.html

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <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>
+
+  <!-- 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>
+</body>
+</html>