Releases: docmd-io/docmd
docmd@0.4.7 🚀
This release focuses on quality-of-life improvements for content authors and polishing the Live Editor experience.
✨ New Features
- GFM Emoji Support: You can now use GitHub-flavored emoji shortcodes in your markdown!
I :heart: documentation :rocket:→ I ❤️ documentation 🚀
- Smart Link Rewriting: You can now link directly to
.mdfiles in your content.docmdwill automatically convert paths like[Guide](guide.md)into clean HTML links (/guide/) during the build. This ensures links work in your code editor (VS Code) and your website.
🛠 Improvements & Fixes
- Parser Stability: Resolved a critical crash (
plugin.apply is not a function) caused by ESM/CommonJS conflicts in the parser dependencies. - Button Syntax: The default template now uses the modern, self-closing button syntax (
::: button "Text" URL). - Live Layout: Fixed iframe resizing issues in the Live Editor to ensure the preview pane fills the available space correctly.
📥 Upgrade
npm install -g @docmd/coreFull Changelog: 0.4.6...0.4.7
docmd@0.4.6 🚀
This release marks a major step forward for docmd as a developer-first tool, introducing native AI support and fixing long-standing parsing edge cases.
✨ New Features
- AI Context Plugin (
llms.txt): Added@docmd/plugin-llms. It automatically generates an/llms.txtfile (mapping to llmstxt.org) to help AI agents like ChatGPT, Claude, and Cursor understand your project context instantly. Resolved #37 - Live Editor Presets: Added a "Chips" toolbar to the Live Editor. Quickly load templates for Mermaid, Tabs, Steps, and Containers to see how
docmdcomponents look in real-time.
🐛 Critical Parser Fixes
- Tabs Indentation: Fixed #40. Code blocks nested inside Tabs now perfectly preserve their internal indentation. No more flattened code!
- Mermaid Live: Fixed a silent rendering failure in the Live Editor by inlining the Mermaid loader directly into the preview iframe.
- Container Nesting: Improved depth-tracking to allow infinite nesting of components (e.g., a Card inside a Step inside a Tab) without early closure.
🖥️ UX & Internal Improvements
- Overlay Scrollbars: Redesigned sidebar scrollbars to use an "overlay" style. This prevents layout shifts and content "jumping" when expanding large sub-menus.
- Asset Ordering: Refactored the build engine to ensure Plugin CSS/JS is injected after Core CSS, making custom overrides easier and more predictable.
- Persistent Highlight Themes: Fixed an issue where code blocks would flash or revert to Light mode on page reload while in Dark mode.
📥 Upgrade
npm install -g @docmd/coreFull Changelog: 0.4.5...0.4.6
docmd@0.4.5 🚀 (Stability & WCAG Improvements)
This release brings stability improvements to the core parser and improves on WCAG standards.
✨ New Features
- Button Syntax: Upgraded the
::: buttoncontainer syntax. It is now a self-closing block, supporting quoted text and mailto links.::: button "Contact Support" mailto:support@example.com - Base Path: We now support a base configuration option in
docmd.config.js. Set base: '/project-name/'. When you write, docmd automatically rewrites it to/project-name/assets/img.pngduring the build. (Feature #43) - Keyboard Shortcuts: Still very early addition but we're adapting to more keyboard friendly UX with WCAG AA standards. Now users can skip sidebar/navigation completely and jump directly to the main-content with keyboard using hidden navigations.
🐛 Bug Fixes
- CSS Minification: Fixed an issue where plugin assets (like Mermaid styles) were not being minified during the build.
- Nested Containers: Resolved parsing logic where closing a nested container (e.g., a Card inside a Step) would break the parent container.
- Port Detection: Improved the
docmd devport check to avoid false positives and "EADDRINUSE" errors on restarts. - Fixed many minor design inconsistencies and broken elements.
📥 Upgrade
npm install -g @docmd/coreFull Changelog: 0.4.4...0.4.5
docmd@0.4.4 🚀 (Live Editor Fix & CLI Options)
This patch addresses a critical packaging issue preventing the Live Editor from building on user machines and adds new CLI flexibility.
✨ New Features
- Build-Only Mode: Added a
--build-onlyflag. You can now rundocmd live --build-onlyto generate the standalone Live Editor bundle in./distwithout starting the local server. This is useful for deploying the editor itself to static hosting.
# Usage
docmd live --build-only🐛 Critical Fixes
- Live Editor Packaging: Fixed an issue where source files (
src/) were excluded from the published NPM package.docmd livenow correctly resolves all internal modules and builds successfully on end-user machines.
🛠 Improvements
- CLI Stability: Fixed missing imports in the global binary that caused crashes on certain commands.
- Zero-Config Assets: New projects created with
docmd initnow use a default Data URI favicon, eliminating 404 errors in the console before user assets are added.
📥 Install
npm install -g @docmd/coreFull Changelog: 0.4.3...0.4.4
docmd@0.4.3 🚀
This release focuses on critical bug fixes for the Live Editor, Markdown parsing logic, and plugin stability.
✨ New Features
- Overlay Scrollbars: Sidebar scrollbars now overlay content instead of taking up physical space, preventing layout shifts when menus expand.
- Theme Toggle: Refactored syntax highlighting logic. We now load both Light and Dark themes and toggle them instantly, fixing issues where code blocks didn't update or persisted incorrectly on reload.
🐛 Critical Fixes
- Live Editor Build: Fixed a packaging issue where source files were missing from the npm package, causing
docmd liveto fail with "Could not resolve browser-entry.js". - Nested Containers: Fixed a "greedy parser" bug where closing a nested container (like a Callout inside a Tab) would prematurely close the parent container. You can now safely nest components!
🔌 Plugins
- Mermaid.js: Switched to ESM imports. This fixes rendering issues with complex diagram types like Kanban and GitGraph which failed to load in previous versions.
📥 Install
npm install -g @docmd/coreFull Changelog: 0.4.2...0.4.3
docmd@0.4.2
Patch release replacing 0.4.1.
0.4.1 was rolled back due to wrongful workspace linking and missing mermaid plugin. This release fixes that issue.
📥 Install
npm install -g @docmd/coreFull Changelog: 0.4.0...0.4.2
docmd@0.4.1 🚀
✨ New Features
- Isomorphic Core: The parsing engine now runs in both Node.js and the Browser.
- Live Editor: New
@docmd/livepackage allows real-time browser-based editing. - Plugin System: New hook-based architecture for Search, SEO, and Analytics.
- Theme Toggle: Fixed issues with dark mode persistence and highlighting.
🐛 Bug Fixes
- Fixed mermaid plugin missing from
core. - Fixed disproportionate buttons in header.
- Dependencies update and minor bug fixes.
⚠️ Breaking Changes
- Renamed: The CLI is now installed via
@docmd/core(formerly@mgks/docmd). - Config:
siteUrlis now required indocmd.config.jsfor sitemap generation.
📥 Install
npm install -g @docmd/coreWhat's Changed
- 0.4.1 patch update by @mgks in #54
- Bump the npm-dependencies group across 1 directory with 3 updates by @dependabot[bot] in #52
Full Changelog: 0.4.0...0.4.1
docmd@0.4.0 🚀 (Major Architecture Overhaul)
This release transitions docmd from a monolithic CLI to a modular monorepo architecture.
✨ New Features
- Isomorphic Core: The parsing engine now runs in both Node.js and the Browser.
- Live Editor: New
@docmd/livepackage allows real-time browser-based editing. - Plugin System: New hook-based architecture for Search, SEO, and Analytics.
- Theme Toggle: Fixed issues with dark mode persistence and highlighting.
📦 Package Split
We have split the logic into specialized packages:
@docmd/core(CLI Runner)@docmd/parser(Markdown Logic)@docmd/ui(Templates & Assets)@docmd/themes(CSS Themes)
⚠️ Breaking Changes
- Renamed: The CLI is now installed via
@docmd/core(formerly@mgks/docmd). - Config:
siteUrlis now required indocmd.config.jsfor sitemap generation.
📥 Install
npm install -g @docmd/coreWhat's Changed
- Initiating 0.4.0 development by @mgks in #45
- merge 0.3.11 by @mgks in #47
- 0.4.0 release by @mgks in #49
Full Changelog: 0.3.11...0.4.0
docmd@0.3.11
Patch release replacing 0.3.10.
0.3.10 was rolled back due to a conflicting comparison code block. This release fixes that issue.
📥 Install
npm install -g @mgks/docmd@latestFull Changelog: 0.3.9...0.3.11
docmd@0.3.10 🚀
This release focuses on critical bug fixes and UI consistency, ensuring your content is preserved exactly as written and the navigation feels smooth and professional.
✨ Key Improvements
- Fixed Code Block Whitespace (#39): Overhauled cleanup logic to prevent the accidental removal of empty lines inside code blocks. Your code examples now maintain perfect formatting.
- Redesigned TOC Sidebar: Added a vertical guide "rail" and fixed a layout shifting bug where active links would cause text to "jump."
- Fixed Navigation Visibility: Submenus without the
collapsibleflag now correctly stay visible by default as a static tree. - Reliable Theme Init: Improved the first-load logic to ensure the theme (Light/Dark) is correctly applied to the entire page immediately.
🐛 Bug Fixes
- Improved parsing of nested containers.
- Fixed scrollbar styling for Dark Mode.
- Resolved WebSocket connection flickering in the browser console.
🔮 What's Next?
This version marks the final stable release of the 0.3.x line. All active development now moves to the dev-0.4.0 branch for the modular monorepo rewrite.
📥 Install
npm install -g @mgks/docmd@latestFull Changelog: 0.3.9...0.3.10
