Skip to content

Releases: docmd-io/docmd

docmd@0.4.7 🚀

17 Feb 12:50

Choose a tag to compare

docmd logo

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 .md files in your content. docmd will 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/core

Full Changelog: 0.4.6...0.4.7

docmd@0.4.6 🚀

16 Feb 12:52

Choose a tag to compare

docmd logo

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.txt file (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 docmd components 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/core

Full Changelog: 0.4.5...0.4.6

docmd@0.4.5 🚀 (Stability & WCAG Improvements)

15 Feb 12:04

Choose a tag to compare

docmd logo

This release brings stability improvements to the core parser and improves on WCAG standards.

✨ New Features

  • Button Syntax: Upgraded the ::: button container 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 ![img](/assets/img.png), docmd automatically rewrites it to /project-name/assets/img.png during 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 dev port check to avoid false positives and "EADDRINUSE" errors on restarts.
  • Fixed many minor design inconsistencies and broken elements.

📥 Upgrade

npm install -g @docmd/core

Full Changelog: 0.4.4...0.4.5

docmd@0.4.4 🚀 (Live Editor Fix & CLI Options)

12 Feb 15:43

Choose a tag to compare

docmd logo

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-only flag. You can now run docmd live --build-only to generate the standalone Live Editor bundle in ./dist without 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 live now 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 init now use a default Data URI favicon, eliminating 404 errors in the console before user assets are added.

📥 Install

npm install -g @docmd/core

Full Changelog: 0.4.3...0.4.4

docmd@0.4.3 🚀

12 Feb 12:39

Choose a tag to compare

docmd logo

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 live to 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/core

Full Changelog: 0.4.2...0.4.3

docmd@0.4.2

12 Feb 10:41

Choose a tag to compare

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/core

Full Changelog: 0.4.0...0.4.2

docmd@0.4.1 🚀

12 Feb 10:38

Choose a tag to compare

docmd logo

✨ New Features

  • Isomorphic Core: The parsing engine now runs in both Node.js and the Browser.
  • Live Editor: New @docmd/live package 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: siteUrl is now required in docmd.config.js for sitemap generation.

📥 Install

npm install -g @docmd/core

What'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)

12 Feb 03:34
ab8566a

Choose a tag to compare

docmd logo

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/live package 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: siteUrl is now required in docmd.config.js for sitemap generation.

📥 Install

npm install -g @docmd/core

What's Changed

Full Changelog: 0.3.11...0.4.0

docmd@0.3.11

03 Feb 22:41

Choose a tag to compare

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@latest

Full Changelog: 0.3.9...0.3.11

docmd@0.3.10 🚀

03 Feb 22:33

Choose a tag to compare

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 collapsible flag 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@latest

Full Changelog: 0.3.9...0.3.10