Skip to content

Release: v0.3.0 (The Discovery Update - Offline Search)#22

Merged
mgks merged 5 commits intomainfrom
dev
Nov 30, 2025
Merged

Release: v0.3.0 (The Discovery Update - Offline Search)#22
mgks merged 5 commits intomainfrom
dev

Conversation

@mgks
Copy link
Member

@mgks mgks commented Nov 30, 2025

Description

This release introduces the most requested feature: Built-in Full-Text Search. It transforms docmd into a complete documentation platform without requiring external services like Algolia.

🚀 Key Features

  • Zero-Config Search: Automatically indexes all content during the build.
  • Offline Capable: Uses MiniSearch to run entirely in the browser. No API keys, no latency.
  • Smart UI: Added a Cmd+K modal with fuzzy matching and keyword highlighting.
  • Configurable: Search can be disabled via search: false in docmd.config.js.
  • Asset Bundling: Refactored build process to bundle minisearch and mermaid from node_modules instead of using CDNs. This ensures the site works 100% offline.
  • Performance: Added logic to strip HTML tags before indexing to keep the search index lightweight.

Type of change

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📝 Documentation update

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings

mgks added 5 commits November 30, 2025 12:05
Introduces comprehensive CSS for a new search UI, including modal, trigger, and result styling. Updates theme accent colors and refines sponsor ribbon styles. Minor JS file header improvements and adds a preview image for dark welcome.
Introduces client-side full-text search using MiniSearch, including search modal UI, keyboard navigation, and fuzzy matching. Search index is generated at build time and bundled with site assets. Updates README and layout to document and enable the feature, with configuration options in init.js.
Updated README to highlight new offline search and improved navigation. Refactored config.js for clarity, added search and navigation features, and reorganized navigation structure. Bumped package version to 0.3.0 and added dependencies for search and diagram support.
Documents the new built-in, offline-capable full-text search feature in docmd. Updates configuration options to include `search`, expands comparison with other tools, and highlights search capabilities in the overview.
@mgks mgks merged commit 232e7fe into main Nov 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant