eslint-doc-generator
Automatically generates and maintains documentation for ESLint plugins and rules, including rule tables, config tables, and rule doc notices.
What is eslint-doc-generator?
eslint-doc-generator is a Node.js tool that automatically generates and maintains documentation for ESLint plugins and rules. It creates README tables, rule doc headers, and options lists based on plugin metadata, ensuring consistency and reducing manual documentation work. It solves the problem of fragmented and outdated ESLint plugin documentation by automating the process.
ESLint plugin maintainers and developers who want to keep their plugin documentation up-to-date and standardized. It's particularly useful for popular ESLint plugins with many rules and configurations.
Developers choose eslint-doc-generator because it eliminates the need for custom documentation scripts, ensures documentation stays synchronized with rule changes, and follows ESLint's official documentation conventions. Its configurability and adoption by major ESLint plugins make it a trusted solution.
Overview
Automatic documentation generator for ESLint plugins and rules.
Use Cases
Best For
- Maintaining large ESLint plugins with dozens of rules
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.