typedoc.configs.markdown
TypeDoc lint preset tuned for projects that generate markdown output with typedoc-plugin-markdown.
What this preset optimizes forโ
This preset focuses on the parts of TypeDoc comments that have the biggest effect on markdown output quality:
- readable summary paragraphs for exported APIs
- actionable deprecation guidance when APIs are marked with
@deprecated - meaningful
@remarkssections when they are present - package-level overview docs
- valid inline links
- non-empty examples
- fenced code blocks with explicit languages
It is intentionally more output-focused than typedoc.configs.recommended, but less exhaustive than typedoc.configs.strict.
When to use this presetโ
Use this preset when your docs pipeline renders TypeDoc comments into markdown pages, READMEs, or Docusaurus content via typedoc-plugin-markdown.
Companion TypeDoc pluginsโ
This ESLint preset does not install or require TypeDoc runtime plugins by itself.
It pairs especially well with:
typedoc-plugin-markdownfor markdown page generationtypedoc-plugin-mdn-linksfor links to global web and TypeScript utility typestypedoc-plugin-dt-linksfor links into@typespackages
typedoc-plugin-coverage is also useful, but it is better treated as a reporting add-on in the TypeDoc pipeline than as part of this ESLint preset.
ESLint flat config exampleโ
import typedocPlugin from "eslint-plugin-typedoc";
export default [typedocPlugin.configs.markdown];
Rules in this presetโ
Fixlegend:๐ง= autofixable๐ก= suggestions availableโ= report only