docmedown 0.1.0

package/dist/types/runtime/app.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+import { DocConfig } from './types';
+import './styles/main.css';
+interface DocMeDownAppProps {
+    config: DocConfig;
+    basePath?: string;
+}
+export declare const DocMeDownApp: React.FC<DocMeDownAppProps>;
+export {};

package/dist/types/runtime/components/Builtins.d.ts

@@ -0,0 +1,44 @@
+import React from 'react';
+export interface TabsProps {
+    children?: React.ReactNode;
+    defaultIndex?: number;
+    groupId?: string;
+}
+export interface TabItemProps {
+    label: string;
+    value?: string;
+    icon?: React.ReactNode;
+    children: React.ReactNode;
+}
+export declare const Tabs: React.FC<TabsProps>;
+export declare const Tab: React.FC<TabItemProps>;
+export interface CardProps {
+    title: string;
+    description?: string;
+    href?: string;
+    icon?: React.ReactNode | string;
+    badge?: string;
+    badgeType?: 'info' | 'success' | 'warning' | 'new';
+    children?: React.ReactNode;
+}
+export declare const Card: React.FC<CardProps>;
+export interface CardGridProps {
+    cols?: 1 | 2 | 3 | 4;
+    children: React.ReactNode;
+}
+export declare const CardGrid: React.FC<CardGridProps>;
+export interface BadgeProps {
+    type?: 'info' | 'success' | 'warning' | 'danger' | 'new';
+    children: React.ReactNode;
+}
+export declare const Badge: React.FC<BadgeProps>;
+export interface StepsProps {
+    children: React.ReactNode;
+}
+export declare const Steps: React.FC<StepsProps>;
+export interface StepProps {
+    title: string;
+    step?: number;
+    children: React.ReactNode;
+}
+export declare const Step: React.FC<StepProps>;

package/dist/types/runtime/components/Content.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const Content: React.FC;

package/dist/types/runtime/components/DmdRegistry.d.ts

@@ -0,0 +1,17 @@
+import React from 'react';
+export type ComponentMap = Record<string, React.ComponentType<any>>;
+export declare class ComponentRegistry {
+    private static instance;
+    private components;
+    private constructor();
+    static getInstance(): ComponentRegistry;
+    private checkGlobalComponents;
+    register(name: string, component: React.ComponentType<any>): void;
+    registerMultiple(map: ComponentMap): void;
+    get(name: string): React.ComponentType<any> | undefined;
+    getAll(): ComponentMap;
+    /**
+     * Dynamically loads custom components from .dmd/components.js if available
+     */
+    loadDmdDirectory(basePath?: string): Promise<void>;
+}

package/dist/types/runtime/components/Layout.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const Layout: React.FC;

package/dist/types/runtime/components/Navbar.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const Navbar: React.FC;

package/dist/types/runtime/components/Sidebar.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const Sidebar: React.FC;

package/dist/types/runtime/components/TableOfContents.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { DocHeading } from '../types';
+interface TOCProps {
+    headings: DocHeading[];
+    currentSlug: string;
+}
+export declare const TableOfContents: React.FC<TOCProps>;
+export {};

package/dist/types/runtime/config.d.ts

@@ -0,0 +1,14 @@
+import { DocConfig } from './types';
+export declare const DEFAULT_CONFIG: DocConfig;
+/**
+ * Normalizes and merges user config with defaults
+ */
+export declare function normalizeConfig(userConfig?: Partial<DocConfig>): DocConfig;
+/**
+ * Attempts to load config from:
+ * 1. window.__DOCMEDOWN_CONFIG__
+ * 2. <script id="dmd-config" type="application/json">
+ * 3. Fetching docs.json / dmd.json relative to the base
+ * 4. Falling back to intelligent defaults
+ */
+export declare function loadDocConfig(basePath?: string): Promise<DocConfig>;

package/dist/types/runtime/index.d.ts

@@ -0,0 +1,6 @@
+import { DocMeDownInitOptions, DocMeDownInstance } from './types';
+export { DocMeDownApp } from './app';
+export { loadDocConfig } from './config';
+export * from './types';
+export * from './components/Builtins';
+export declare function initDocMeDown(options?: DocMeDownInitOptions): Promise<DocMeDownInstance | null>;

package/dist/types/runtime/loader/auto-indexer.d.ts

@@ -0,0 +1,3 @@
+import { SidebarTreeNode, SidebarItemConfig, DocFrontmatter } from '../types';
+export declare function formatTitleFromFilename(name: string): string;
+export declare function buildSidebarTree(files: string[], frontmatters?: Record<string, DocFrontmatter>, manualSidebar?: SidebarItemConfig[]): SidebarTreeNode[];

package/dist/types/runtime/loader/local-loader.d.ts

@@ -0,0 +1,11 @@
+import { DocManifest } from '../types';
+export declare class LocalDocLoader {
+    private embeddedManifest;
+    private cache;
+    constructor();
+    private checkEmbeddedData;
+    getEmbeddedManifest(): DocManifest | null;
+    fetchManifest(basePath?: string): Promise<DocManifest | null>;
+    fetchDocContent(slug: string, basePath?: string): Promise<string | null>;
+    private normalizeKey;
+}

package/dist/types/runtime/loader/remote-github.d.ts

@@ -0,0 +1,10 @@
+import { RemoteSourceConfig } from '../types';
+export declare class RemoteGithubLoader {
+    private config;
+    private cache;
+    private treeCache;
+    constructor(config: RemoteSourceConfig);
+    private getHeaders;
+    discoverFiles(): Promise<string[]>;
+    fetchDocContent(slug: string): Promise<string | null>;
+}

package/dist/types/runtime/loader/remote-gitlab.d.ts

@@ -0,0 +1,9 @@
+import { RemoteSourceConfig } from '../types';
+export declare class RemoteGitlabLoader {
+    private config;
+    private cache;
+    constructor(config: RemoteSourceConfig);
+    private getHeaders;
+    discoverFiles(): Promise<string[]>;
+    fetchDocContent(slug: string): Promise<string | null>;
+}

package/dist/types/runtime/markdown/callouts.d.ts

@@ -0,0 +1,17 @@
+export interface CalloutInfo {
+    type: 'note' | 'tip' | 'important' | 'warning' | 'caution';
+    title: string;
+    content: string;
+}
+export declare const CALLOUT_ICONS: {
+    note: string;
+    tip: string;
+    important: string;
+    warning: string;
+    caution: string;
+};
+/**
+ * Transforms GitHub alert blockquotes into DocMeDown callouts
+ * e.g. > [!NOTE] or > [!WARNING] Title
+ */
+export declare function processAlerts(markdown: string): string;

package/dist/types/runtime/markdown/highlighter.d.ts

@@ -0,0 +1,19 @@
+import 'prismjs/components/prism-clike';
+import 'prismjs/components/prism-javascript';
+import 'prismjs/components/prism-typescript';
+import 'prismjs/components/prism-jsx';
+import 'prismjs/components/prism-tsx';
+import 'prismjs/components/prism-bash';
+import 'prismjs/components/prism-json';
+import 'prismjs/components/prism-yaml';
+import 'prismjs/components/prism-css';
+import 'prismjs/components/prism-markdown';
+import 'prismjs/components/prism-python';
+import 'prismjs/components/prism-rust';
+import 'prismjs/components/prism-go';
+import 'prismjs/components/prism-sql';
+import 'prismjs/components/prism-docker';
+import 'prismjs/components/prism-diff';
+export declare function highlightCode(code: string, lang?: string): string;
+export declare function escapeHtml(str: string): string;
+export declare function renderCodeBlock(code: string, infoString?: string): string;

package/dist/types/runtime/markdown/katex.d.ts

@@ -0,0 +1 @@
+export declare function renderMath(content: string): string;

package/dist/types/runtime/markdown/mermaid.d.ts

@@ -0,0 +1 @@
+export declare function renderMermaidDiagrams(): Promise<void>;

package/dist/types/runtime/markdown/parser.d.ts

@@ -0,0 +1,17 @@
+import { DocFrontmatter, DocHeading } from '../types';
+export interface ParsedMarkdown {
+    frontmatter: DocFrontmatter;
+    html: string;
+    headings: DocHeading[];
+    readingTimeMinutes: number;
+}
+/**
+ * Extracts YAML frontmatter without external runtime dependencies for browser friendliness
+ */
+export declare function extractFrontmatter(rawMarkdown: string): {
+    frontmatter: DocFrontmatter;
+    content: string;
+};
+export declare function slugifyHeading(text: string): string;
+export declare function calculateReadingTime(text: string): number;
+export declare function parseMarkdown(rawContent: string, currentSlug?: string): ParsedMarkdown;

package/dist/types/runtime/markdown/renderer.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+interface MarkdownRendererProps {
+    html: string;
+    onNavigate?: (slug: string, anchor: string) => void;
+}
+export declare const MarkdownRenderer: React.FC<MarkdownRendererProps>;
+export {};

package/dist/types/runtime/provider/DocProvider.d.ts

@@ -0,0 +1,38 @@
+import React from 'react';
+import { DocConfig, SidebarTreeNode } from '../types';
+import { HashRouter } from '../router';
+import { ParsedMarkdown } from '../markdown/parser';
+import { DocSearchIndex } from '../search/search-index';
+export interface ActiveDocData extends ParsedMarkdown {
+    slug: string;
+    title: string;
+}
+export interface NavDocItem {
+    slug: string;
+    title: string;
+}
+interface DocContextType {
+    config: DocConfig;
+    router: HashRouter;
+    currentSlug: string;
+    currentDoc: ActiveDocData | null;
+    tree: SidebarTreeNode[];
+    searchIndex: DocSearchIndex;
+    isLoading: boolean;
+    error: string | null;
+    prevDoc: NavDocItem | null;
+    nextDoc: NavDocItem | null;
+    isSearchOpen: boolean;
+    setIsSearchOpen: (open: boolean) => void;
+    isMobileSidebarOpen: boolean;
+    setIsMobileSidebarOpen: (open: boolean) => void;
+    navigate: (slug: string, anchor?: string) => void;
+}
+export declare const useDoc: () => DocContextType;
+interface DocProviderProps {
+    initialConfig: DocConfig;
+    basePath?: string;
+    children: React.ReactNode;
+}
+export declare const DocProvider: React.FC<DocProviderProps>;
+export {};

package/dist/types/runtime/provider/ThemeProvider.d.ts

@@ -0,0 +1,18 @@
+import React from 'react';
+import { ColorMode, ThemePreset } from '../types';
+interface ThemeContextType {
+    mode: ColorMode;
+    resolvedMode: 'light' | 'dark';
+    preset: ThemePreset;
+    setMode: (mode: ColorMode) => void;
+    setPreset: (preset: ThemePreset) => void;
+    toggleMode: () => void;
+}
+export declare const useTheme: () => ThemeContextType;
+interface ThemeProviderProps {
+    defaultMode?: ColorMode;
+    defaultPreset?: ThemePreset;
+    children: React.ReactNode;
+}
+export declare const ThemeProvider: React.FC<ThemeProviderProps>;
+export {};

package/dist/types/runtime/router.d.ts

@@ -0,0 +1,23 @@
+export interface RouteInfo {
+    slug: string;
+    anchor: string;
+    fullPath: string;
+}
+export declare class HashRouter {
+    private listeners;
+    private defaultDoc;
+    constructor(defaultDoc?: string);
+    destroy(): void;
+    setDefaultDoc(defaultDoc: string): void;
+    getCurrentRoute(): RouteInfo;
+    parseHash(rawHash: string): RouteInfo;
+    normalizeDocSlug(pathOrSlug: string): string;
+    navigate(path: string, anchor?: string): void;
+    scrollToAnchor(anchorId: string): void;
+    subscribe(callback: (route: RouteInfo) => void): () => void;
+    private handleHashChange;
+    /**
+     * Resolves a relative markdown link into a hash navigation target
+     */
+    resolveLink(href: string, currentSlug: string): string;
+}

package/dist/types/runtime/search/SearchModal.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import { DocSearchIndex } from './search-index';
+interface SearchModalProps {
+    isOpen: boolean;
+    onClose: () => void;
+    searchIndex: DocSearchIndex;
+    onSelect: (slug: string) => void;
+    placeholder?: string;
+}
+export declare const SearchModal: React.FC<SearchModalProps>;
+export {};

package/dist/types/runtime/search/search-index.d.ts

@@ -0,0 +1,9 @@
+import { DocFileItem, SearchResultItem } from '../types';
+export declare class DocSearchIndex {
+    private miniSearch;
+    private indexedDocs;
+    constructor();
+    addDoc(doc: DocFileItem): void;
+    addDocs(docs: DocFileItem[]): void;
+    search(query: string, limit?: number): SearchResultItem[];
+}

package/dist/types/runtime/types.d.ts

@@ -0,0 +1,165 @@
+/**
+ * DocMeDown Configuration and Runtime Type Definitions
+ */
+export type ThemePreset = 'indigo' | 'emerald' | 'sunset' | 'violet' | 'rose' | 'slate' | 'cyberpunk';
+export type ColorMode = 'light' | 'dark' | 'auto';
+export interface NavLink {
+    label: string;
+    href: string;
+    external?: boolean;
+    icon?: string;
+}
+export interface SocialLink {
+    type: 'github' | 'gitlab' | 'twitter' | 'x' | 'discord' | 'custom';
+    url: string;
+    label?: string;
+    icon?: string;
+}
+export interface RemoteSourceConfig {
+    type: 'github' | 'gitlab' | 'raw';
+    /** e.g. "facebook/react" or "owner/repo" */
+    repo?: string;
+    /** e.g. "main" or "master" */
+    branch?: string;
+    /** Subdirectory where markdown files live, e.g. "docs" or "" */
+    docsDir?: string;
+    /** Optional personal access token or auth for private repos */
+    token?: string;
+    /** Raw base URL override */
+    baseUrl?: string;
+}
+export interface SidebarItemConfig {
+    title?: string;
+    path?: string;
+    slug?: string;
+    icon?: string;
+    badge?: string;
+    badgeType?: 'info' | 'success' | 'warning' | 'new';
+    collapsed?: boolean;
+    children?: SidebarItemConfig[];
+}
+export interface DocThemeConfig {
+    preset?: ThemePreset;
+    defaultMode?: ColorMode;
+    accentColor?: string;
+    accentColorDark?: string;
+    fontFamily?: string;
+    codeTheme?: 'github' | 'dracula' | 'one-dark' | 'synthwave';
+    logo?: {
+        light?: string;
+        dark?: string;
+        alt?: string;
+        text?: string;
+    };
+    favicon?: string;
+}
+export interface DocSearchConfig {
+    enabled?: boolean;
+    placeholder?: string;
+    maxResults?: number;
+}
+export interface DocConfig {
+    name: string;
+    tagline?: string;
+    description?: string;
+    version?: string;
+    rootDoc?: string;
+    /** Source configuration: local filesystem or remote GitHub/GitLab */
+    source?: RemoteSourceConfig;
+    /** Visual and theme configurations */
+    theme?: DocThemeConfig;
+    /** Navigation bar links */
+    nav?: NavLink[];
+    /** Social and repository links */
+    socials?: SocialLink[];
+    /** Manual sidebar configuration (optional; auto-indexed if omitted) */
+    sidebar?: SidebarItemConfig[];
+    /** Auto-indexing options */
+    autoIndex?: {
+        enabled?: boolean;
+        exclude?: string[];
+        sort?: 'alphabetical' | 'frontmatter' | 'natural';
+        defaultCollapsed?: boolean;
+    };
+    /** Search options */
+    search?: DocSearchConfig;
+    /** Footer config */
+    footer?: {
+        copyright?: string;
+        links?: NavLink[];
+        showBuiltWith?: boolean;
+    };
+    /** Custom component directory or URL */
+    componentsUrl?: string;
+    /** Edit page link (e.g. "https://github.com/owner/repo/edit/main/docs/") */
+    editUrl?: string;
+}
+/** Options accepted by the browser integration entry point. */
+export interface DocMeDownInitOptions {
+    el?: string | HTMLElement;
+    config?: Partial<DocConfig>;
+    basePath?: string;
+}
+/** Handle returned after mounting DocMeDown into a page. */
+export interface DocMeDownInstance {
+    element: HTMLElement;
+    destroy: () => void;
+}
+export interface DocHeading {
+    level: number;
+    text: string;
+    id: string;
+}
+export interface DocFrontmatter {
+    title?: string;
+    sidebar_label?: string;
+    sidebar_position?: number;
+    order?: number;
+    description?: string;
+    icon?: string;
+    badge?: string;
+    badge_type?: 'info' | 'success' | 'warning' | 'new';
+    tags?: string[];
+    hidden?: boolean;
+    [key: string]: any;
+}
+export interface DocFileItem {
+    slug: string;
+    path: string;
+    title: string;
+    category?: string;
+    frontmatter: DocFrontmatter;
+    headings: DocHeading[];
+    content?: string;
+    readingTimeMinutes?: number;
+    lastModified?: string;
+}
+export interface DocManifest {
+    version: string;
+    generatedAt: string;
+    config: DocConfig;
+    docs: DocFileItem[];
+    tree: SidebarTreeNode[];
+}
+export interface SidebarTreeNode {
+    id: string;
+    title: string;
+    slug?: string;
+    path?: string;
+    icon?: string;
+    badge?: string;
+    badgeType?: 'info' | 'success' | 'warning' | 'new';
+    order: number;
+    isCategory: boolean;
+    collapsed?: boolean;
+    children?: SidebarTreeNode[];
+}
+export interface SearchResultItem {
+    id: string;
+    slug: string;
+    title: string;
+    category?: string;
+    snippet?: string;
+    heading?: string;
+    score?: number;
+}

package/package.json

@@ -0,0 +1,110 @@
+{
+  "name": "docmedown",
+  "version": "0.1.0",
+  "description": "The simplest MarkDown documenter yet. CLI & Web Script React SPA documentation engine.",
+  "main": "./dist/docmedown.cjs",
+  "module": "./dist/docmedown.mjs",
+  "types": "./dist/types/runtime/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/runtime/index.d.ts",
+      "import": "./dist/docmedown.mjs",
+      "require": "./dist/docmedown.cjs"
+    },
+    "./iife": "./dist/docmedown.iife.js"
+  },
+  "unpkg": "./dist/docmedown.iife.js",
+  "jsdelivr": "./dist/docmedown.iife.js",
+  "bin": {
+    "docmedown": "bin/docmedown.js",
+    "dmd": "bin/docmedown.js"
+  },
+  "files": [
+    "dist",
+    "bin",
+    "templates",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "dev:runtime": "vite build --watch",
+    "build:runtime": "vite build",
+    "build:cli": "tsup",
+    "typecheck": "tsc --noEmit",
+    "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",
+    "dmd": "node ./bin/docmedown.js",
+    "init:docs": "node ./bin/docmedown.js init",
+    "serve": "node ./bin/docmedown.js serve ./docs",
+    "dev": "node ./bin/docmedown.js serve ./docs",
+    "build:docs": "node ./bin/docmedown.js build ./docs",
+    "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",
+    "prepublishOnly": "npm run test:release"
+  },
+  "keywords": [
+    "markdown",
+    "documentation",
+    "docs",
+    "docusaurus",
+    "docsify",
+    "react",
+    "spa",
+    "cli",
+    "offline-docs",
+    "github-docs"
+  ],
+  "author": "Gabriel M. Silva",
+  "license": "MIT",
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gabrielmsilva00/docmedown.git"
+  },
+  "bugs": {
+    "url": "https://github.com/gabrielmsilva00/docmedown/issues"
+  },
+  "homepage": "https://github.com/gabrielmsilva00/docmedown#readme",
+  "packageManager": "npm@11.16.0",
+  "overrides": {
+    "tsup": {
+      "esbuild": "0.28.2"
+    }
+  },
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "chokidar": "^3.6.0",
+    "commander": "^12.1.0",
+    "gray-matter": "^4.0.3",
+    "mime-types": "^2.1.35",
+    "open": "^10.1.0",
+    "prompts": "^2.4.2",
+    "ws": "^8.18.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.5.0",
+    "@types/prismjs": "^1.26.6",
+    "@types/prompts": "^2.4.9",
+    "@types/react": "^18.3.5",
+    "@types/react-dom": "^18.3.0",
+    "@types/ws": "^8.5.12",
+    "@vitejs/plugin-react": "^6.1.0",
+    "katex": "^0.16.11",
+    "marked": "^14.1.1",
+    "minisearch": "^7.1.0",
+    "prismjs": "^1.29.0",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "tsup": "^8.2.4",
+    "tsx": "^4.19.0",
+    "typescript": "^5.5.4",
+    "vite": "^8.2.2",
+    "vite-plugin-css-injected-by-js": "^5.0.2"
+  }
+}

package/templates/.dmd/components.js

@@ -0,0 +1,25 @@
+const { createElement, useState } = window.React;
+
+export function CounterWidget({ initial = 0 }) {
+  const [count, setCount] = useState(Number(initial));
+
+  return createElement(
+    'button',
+    {
+      type: 'button',
+      onClick: () => setCount((value) => value + 1),
+      style: {
+        padding: '0.55rem 0.85rem',
+        border: '1px solid var(--dmd-accent)',
+        borderRadius: '6px',
+        background: 'var(--dmd-accent-subtle)',
+        color: 'var(--dmd-text-primary)',
+        cursor: 'pointer',
+        fontWeight: 700,
+      },
+    },
+    `Interactive counter: ${count}`
+  );
+}
+
+export default { CounterWidget };