documentationjs/documentation
Documentation
Documentation.js is a multi-purpose documentation tool that parses JSDoc annotations from JavaScript and TypeScript source files to generate formatted API documentation. It functions as both a documentation generator and a JSDoc linter, scanning source code for non-standard or incorrect annotations and returning human-readable warnings to enforce documentation quality.
The tool operates through a pipeline-based architecture that parses JSDoc comments into an abstract syntax tree, validates annotations against style and correctness rules, and outputs documentation through interchangeable plugin formatters. It supports generating documentation in HTML, Markdown, and JSON formats, and can inject API documentation directly into existing README files by replacing designated sections. The system also generates clickable links to original source files on GitHub within HTML output, and can be configured to parse TypeScript source files through custom file extension resolution.
Documentation.js processes documentation output as Vinyl file objects, enabling pipeline-based transformations and support for multiple output formats. It can build documentation exclusively for exported module values, ignoring internal symbols, and provides a structured list of documented items from root source files.
Features
- JavaScript API Documentation - Parses JSDoc comments from source code and outputs formatted documentation in HTML, Markdown, or JSON.
- API Documentation Injectors - Updates README.md files with API documentation extracted from specified source files.
- JSDoc Comment Linters - Scans source files for non-standard or incorrect JSDoc annotations and returns human-readable warnings.
- JSDoc Style Linters - Checks source code for common JSDoc style and uniformity mistakes to enforce documentation quality.
- API Documentation Generators - Parses JSDoc comments from a root source file and returns a structured list of documented items.
- JSDoc Annotation Linters - Scans source files for non-standard or incorrect JSDoc annotations and returns human-readable warnings.
- API Documentation Injectors - Updates README.md files with API documentation extracted from specified source files.
- JSDoc Annotation Generators - Generates API documentation from JSDoc annotations in JavaScript and TypeScript source files.
- JSDoc Annotation Validators - Scans source files for non-standard or incorrect JSDoc annotations and returns human-readable warnings.
- JSDoc AST Parsers - Parses JavaScript source files into an abstract syntax tree to extract structured documentation from JSDoc comments.
- JSDoc Comment Linting Pipelines - Validates JSDoc annotations against style and correctness rules during the parsing process.
- Documentation Format Plugins - Uses a plugin architecture to convert parsed documentation into HTML, Markdown, or JSON through interchangeable formatters.
- README Section Injections - Updates existing README files by replacing API sections with newly generated documentation content.
- JSDoc Markdown Formatters - Converts parsed JSDoc comments into Markdown-formatted documentation output.
- JSDoc JSON Formatters - Converts parsed JSDoc comments into a JSON string representation.
- Exported Symbol Documenters - Builds documentation exclusively for values exported by a module, ignoring internal symbols.
- README API Injectors - Updates a README.md file's API section with documentation extracted from specified source files.
- Source Repository Links - Generates clickable links to original source files on GitHub within HTML documentation output.
- TypeScript - Generates documentation from TypeScript source files by configuring the parser to handle custom file extensions.
- TypeScript - Generates documentation from TypeScript source files by parsing JSDoc annotations.
- TypeScript Source File Parsers - Generates documentation from TypeScript files by specifying a custom file extension for parsing.
- TypeScript Parsing Extensions - Extends parsing capabilities to handle TypeScript source files through configurable file extension resolution.
- JSDoc HTML Formatters - Converts parsed JSDoc comments into HTML output using Vinyl file objects.
- Documentation Generators - Generates documentation directly from JavaScript source code.
