A documentation system so good, you'll actually write documentation. documentation.js has pluggable output formats: you can get raw documentation as JSON, beautiful, customizable HTML, or Markdown that fits perfectly into an API.md or README.md file in a GitHub repository. Demos, self-documentation as HTML, Markdown, JSON. documentation.js aims to cover all flavors of modern JavaScript. documentation.js works in your workflow, whether you just want a command-line utility that generates documentation from your code, you use Gulp to publish websites, or you're building a new system and want low-level JavaScript methods. Infers parameters, types, membership, and more. Write less documentation: let the computer write it for you. Integrates with GitHub to link directly from documentation to the code it refers to.

Features

  • Supports modern JavaScript: ES5, ES2017, JSX, Vue and Flow type annotations
  • Infers parameters, types, membership, and more
  • Write less documentation, let the computer write it for you
  • Integrates with GitHub to link directly from documentation to the code it refers to
  • Customizable output
  • HTML, JSON, Markdown, and more

Project Samples

Project Activity

See All Activity >

Categories

Documentation

License

ISC License

Follow documentation.js

documentation.js Web Site

You Might Also Like
Gen AI apps are built with MongoDB Atlas Icon
Gen AI apps are built with MongoDB Atlas

The database for AI-powered applications.

MongoDB Atlas is the developer-friendly database used to build, scale, and run gen AI and LLM-powered apps—without needing a separate vector database. Atlas offers built-in vector search, global availability across 115+ regions, and flexible document modeling. Start building AI apps faster, all in one place.
Start Free
Rate This Project
Login To Rate This Project

User Reviews

Be the first to post a review of documentation.js!

Additional Project Details

Operating Systems

Windows

Programming Language

JavaScript

Related Categories

JavaScript Documentation Software

Registered

2022-04-06