Skip to content

Release: Version 0.2.7#18

Merged
mgks merged 6 commits intomainfrom
dev
Nov 25, 2025
Merged

Release: Version 0.2.7#18
mgks merged 6 commits intomainfrom
dev

Conversation

@mgks
Copy link
Member

@mgks mgks commented Nov 25, 2025

This release focuses heavily on Developer Experience (DX) and User Interface (UI) refinements. It addresses common friction points for new users (configuration errors) and improves the browsing experience on mobile and smaller screens (tables and navigation).

Additionally, this PR establishes the project's "Community Health" by adding standard GitHub issue templates, a code of conduct, and security policies, signaling that docmd is ready for broader adoption.

🚀 Key Changes

1. Smart Configuration Validation

We have introduced a new configuration validator that runs at startup. It parses docmd.config.js and provides helpful feedback before the build starts.

  • Typo Detection: Warns if users type customCSS instead of customCss or customJS instead of customJs.
  • Type Safety: Throws a clear error if navigation or customJs are not Arrays, preventing obscure runtime crashes later in the build process.

2. UI/UX Improvements

  • Responsive Tables: Fixed an issue where wide tables would break the layout on mobile devices. Tables are now automatically wrapped in a scrolling container (.table-wrapper) via a custom Markdown-it rule, enabling smooth horizontal scrolling without JavaScript.
  • Enhanced Sidebar Navigation:
    • Click-to-Expand: Clicking the text label of a parent menu item now expands/collapses the submenu (previously only the arrow icon triggered this). (Imp Drop-down for sub-menu navigation - needs improvement. #17 )
    • Placeholder Support: Added support for path: '#' in navigation config. This allows creating "Section Headers" that toggle submenus but don't link to a specific page.

3. Documentation & Community

  • New Comparison Page: A transparent comparison of docmd vs. Docusaurus, MkDocs, Mintlify, and Docsify to help users make informed decisions.
  • New Recipes Section: Added step-by-step guides for common customizations:
    • Adding Custom Fonts (Google Fonts).
    • Creating a Marketing Landing Page (No-Style).
    • Adding a Custom Favicon.
  • Community Health Files: Added .github/ directory containing:
    • YAML-based Issue Templates (Bug & Feature).
    • Pull Request Template.
    • Code of Conduct & Security Policy.

4. Internal

  • Updated core dependencies (chokidar, fs-extra) to their latest stable versions.
  • Refactored docmd-main.js to handle the new sidebar event logic.

🧪 Testing

  1. Validator Test:
    • Intentionally break docmd.config.js (e.g., set navigation: "string").
    • Run docmd build.
    • Expected: Build fails immediately with a red error message explaining the type mismatch.
  2. Table Test:
    • Create a markdown table with many columns.
    • View on mobile size.
    • Expected: The table should scroll horizontally; the page layout should remain intact.
  3. Sidebar Test:
    • Click the text of a parent menu item.
    • Expected: The submenu toggles open/closed.

mgks added 6 commits November 25, 2025 13:23
Introduces a new config-validator module to check for required fields, type correctness, and common typos in the configuration file. Updates config-loader to use the validator and provide clearer error messages, improving robustness and developer experience.
Introduces new documentation pages for common customization recipes (custom fonts, favicon, landing page) and a detailed comparison between docmd and other documentation tools. Updates config.js to add 'Recipes' and 'Comparison' sections to the navigation menu for improved discoverability.
Update package.json and package-lock.json to version 0.2.7. Also update js-yaml dependencies to latest patch versions for improved security and stability.
Expanded and refactored main CSS for better readability and maintainability, including new styles for tables and other components. Updated JS navigation logic for collapsible sidebar items to improve UX. Enhanced Markdown rendering to wrap tables in a scrollable container for better mobile and desktop usability.
Introduces CODE_OF_CONDUCT.md, SECURITY.md, issue templates for bug reports and feature requests, and a pull request template to standardize contribution, reporting, and review processes.
@mgks
Copy link
Member Author

mgks commented Nov 25, 2025

#17 Improvement added

@mgks mgks merged commit 9657f0a into main Nov 25, 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