Release Note for docmd 0.5.1
This release focuses on refining the developer experience, enhancing our AI-First approach, and introducing powerful new plugins for the ecosystem.
🚀 New Features
1. Progressive Web App (PWA) Plugin 📱
You can now instantly turn your documentation site into an installable application with a robust Service Worker for offline availability! The @docmd/plugin-pwa is shipped natively.
- Zero Config: Add
pwa: {}to your config plugins and it automatically generatesmanifest.webmanifest,service-worker.js, and injects all meta tags. - Customizable: Allows overriding the
<meta>theme colors, backgrounds, and explicitpwa.logopaths. - Offline First: Instantly caches requests using a network-first strategy, allowing your users to browse documentation seamlessly on airplanes or trains.
2. AI First Full Context Generation 🤖
docmd 0.5.1 is officially the easiest static site generator for LLMs to consume natively.
llms-full.txtGeneration: Beyond the structuralllms.txt, the LLM Plugin now concatenates the raw, unmodified markdown content of your entire documentation repository into a single unifiedllms-full.txtfile. Give it directly to ChatGPT or Claude to immediately inject your entire codebase context in one shot.
3. Deep Section Linking in Search 🔍
- The Search Plugin has been overhauled to provide hyper-granular results. Instead of just taking users to matching pages, search results are now broken down by Header sections (
<h3>,<h4>etc) and seamlessly deeply link users straight to the exact paragraph the keyword originates from.
🛠️ Improvements & Fixes
✨ Zero-Config Hardening
- Smarter Path Resolving: Zero-Config mode now automatically detects
docs,src/docs, andcontentbase folders natively. - Metadata Fallbacks: Zero-Config will automatically try to ingest the root
package.jsonto assign the propernameanddescriptionto the documentation site natively. - Failsafe Executions: Dev Loops are completely eradicated. If you run
docmd devin a folder that has zero Markdown files anywhere to be found, it now cleanly aborts with a useful error message instead of spamming watcher loops indefinitely.
🐛 Bug Fixes
- SPA Query Selector: Fixed a crash in
docmd-main.jswhich caused navigation loops when users manually clicked Anchor tags with IDs starting with numeric values. - SEO AI Bot Blacklist: Added native
seo.aiBotsconfiguration support which automatically blankets your meta headers with<meta name="GPTBot" content="noindex">tags across 12 prominent model scrapers for projects that need privacy. - Meta Description: If you omit a frontmatter description from a Markdown file, the SEO plugin automatically constructs a rich excerpt fallback from the first 150 characters of the content securely.
📥 Upgrade
npm install -g @docmd/core
Full Changelog: https://github.com/docmd-io/docmd/compare/0.5.0...0.5.1