{"repo":"eslint-community/eslint-doc-generator","free":true,"listed":false,"github":"https://github.com/eslint-community/eslint-doc-generator","clone":"git clone https://github.com/eslint-community/eslint-doc-generator.git","description":"Automatic documentation generator for ESLint plugins and rules.","language":"TypeScript","stars":112,"topics":["documentation","eslint","eslint-plugin","generator","javascript","lint","linter","linting","typescript"],"license":null,"category":"docs-static-sites","readme_excerpt":"eslint-doc-generator [![npm version][npm-image]][npm-url] Automatic documentation generator for ESLint plugins and rules. Inspired by documentation conventions from ESLint and top ESLint plugins. Generates the following documentation covering a wide variety of rule metadata: - README.md rules table - README.md configs table - Rule doc titles and notices - Rule doc options lists Also performs configurable section consistency checks on rule docs: - Contains an ## Options or ## Config section and mentions each named option (for rules with options) Table of contents - Motivation - Setup - Scripts - Update README.md - Update rule docs - Configure linting - Usage - Examples - Rules list table - Configs list table - Rule doc notices - Rule doc options lists - Users - Configuration options - Column and notice types - --config-format - --framework - --rule-doc-title-format - --suggest-emojis - Configuration file - Badges - Compatibility - Build tools - markdownlint - prettier - Line endings - File Types - Semantic versioning policy - Related Motivation - Standardize documentation across thousands of ESLint plugins and rules - Improve the discoverability of key rule information and thus rule usability - Streamline the process of adding/updating rules while ensuring documentation is kept up-to-date - Eliminate the custom documentation scripts and tests previously built and maintained by many ESLint plugins Setup Install it: Scripts Add scripts to package.json : - Both a lint script to e","default_branch":null,"files":null,"tree":[],"storefront":"/r/eslint-community","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/eslint-community/eslint-doc-generator/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}