docmd v0.3.0 🚀 (The Discovery Update)

[mgks]

This is a milestone release for docmd. We are introducing a completely local, zero-configuration Full-Text Search engine. This transforms docmd from a static site generator into a full-featured documentation platform.

🔍 Major Feature: Instant Search

Search is often the hardest part of setting up documentation. Usually, you have to register for external services (like Algolia), manage API keys, or set up complex server-side infrastructure.

With docmd v0.3.0, search just works.

• Zero Configuration: Just build your site. We automatically index your content.
• Offline Capable: The search runs entirely in the browser. It works on intranets, private networks, and airplanes.
• Fuzzy Matching: Finds what users are looking for, even if they make typos.
• Contextual Snippets: Search results show a preview of the matching text with keywords highlighted.
• Keyboard First: Press Cmd+K / Ctrl+K to search from anywhere. Navigate results with Arrows and Enter.

🛠️ Improvements

• Optimized Assets: The minisearch and mermaid libraries are now bundled efficiently during the build process, reducing external requests and ensuring stability.
• Layout: Refined header layout to accommodate the new search trigger.

🐞 Bug Fixes

• Source Maps: Fixed 404 console errors related to missing source map files for bundled libraries.
• JSON Parsing: Resolved an issue where search indexing could fail on specific Node.js environments due to strict JSON parsing.

⬆️ How to Upgrade

To update your global installation:

npm install -g @mgks/docmd@latest

Full Changelog: 0.2.9...0.3.0

❤️ Support the Project

---

This discussion was created from the release docmd v0.3.0 🚀 (The Discovery Update).