@docmd/live
v0.4.7
Published
Browser-based editor engine for docmd
Maintainers
Readme
@docmd/live
The browser-based engine that powers the docmd Live Editor.
This package bundles the core parser, UI, and themes into a standalone JavaScript bundle that can render documentation client-side without a Node.js server.
Links
- Live Demo: live.docmd.io
- Main Project: github.com/docmd-io/docmd
Usage (CLI)
You can run the editor locally:
docmd liveUsage (Programmatic)
To embed the editor engine in your own tools:
import { buildLive } from '@docmd/core';
await buildLive();The docmd Ecosystem
docmd is a modular system. Here are the official packages:
The Engine
- @docmd/core - The CLI runner and build orchestrator.
- @docmd/parser - The pure Markdown-to-HTML logic.
- @docmd/live - The browser-based Live Editor bundle.
Interface & Design
- @docmd/ui - Base EJS templates and assets.
- @docmd/themes - Official themes (Sky, Ruby, Retro).
Plugins
- @docmd/plugin-search - Offline full-text search.
- @docmd/plugin-mermaid - Diagrams and flowcharts.
- @docmd/plugin-seo - Meta tags and Open Graph data.
- @docmd/plugin-sitemap - Automatic sitemap generation.
- @docmd/plugin-llms - AI context generation.
- @docmd/plugin-analytics - Google Analytics integration.
License
Distributed under the MIT License. See LICENSE for more information.
