Conversation
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.
Member
Author
|
#17 Improvement added |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
docmdis 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.jsand provides helpful feedback before the build starts.customCSSinstead ofcustomCssorcustomJSinstead ofcustomJs.navigationorcustomJsare not Arrays, preventing obscure runtime crashes later in the build process.2. UI/UX Improvements
.table-wrapper) via a custom Markdown-it rule, enabling smooth horizontal scrolling without JavaScript.path: '#'in navigation config. This allows creating "Section Headers" that toggle submenus but don't link to a specific page.3. Documentation & Community
docmdvs. Docusaurus, MkDocs, Mintlify, and Docsify to help users make informed decisions..github/directory containing:4. Internal
chokidar,fs-extra) to their latest stable versions.docmd-main.jsto handle the new sidebar event logic.🧪 Testing
docmd.config.js(e.g., setnavigation: "string").docmd build.