JavaScript documentation generators

Nov 11, 2020 • ☕️ 1 min read

The inner workings are pretty simple. You just need to add comments to your methods in a given way and run following doc generators. They will scan the code to generate an HTML documentation website for you.

JSDoc

An API documentation generator for JavaScript, support many templates and output formats, can work as standalone tool or integrated to other build tools.

ESDoc

An API documentation generator for JavaScript, inspired by JSDoc, supports ES2015 and later, generates detailed document, integrates the test code and more.

Natural Docs

A general documentation generator for 21+ programming languages including JavaScript, designed to be very natural and readable.

Docco

Docco is a quick-and-dirty, hundred-line-long, literate-programming-style documentation generator.

Documentation.js

A documentation system for modern JavaScript; supports ES5, ES2017, JSX, Vue and Flow type annotations; infers parameters, types, membership, and more.

Related Posts

Imposter syndrome self-diagnosis

People say Impostor Syndrome makes you feel like an intellectual fraud. Are you suffering from this phenomenon?

React frameworks

React based frameworks with built-in styling, routing, and many more features

The opinionated decision on CSS resets

On debate of different strategies to fix inconsistent default styles across browsers using Reset, Normalize or Custom CSS

Technical Writing, Part 1: Motivation

I've been writing blog posts since 2017 but haven't learned technical writing properly as a writer