JavaScript Documentation

Open-source JavaScript projects categorized as Documentation

Top 23 JavaScript Documentation Projects

  • mermaid

    Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown

  • Project mention: Creating Animated Diagrams for LinkedIn | dev.to | 2024-04-22

    Mermaid - https://mermaid.js.org/

  • docsify

    🃏 A magical documentation site generator.

  • Project mention: Alternatives to Docusaurus for product documentation | dev.to | 2024-04-04

    Docsify is frequently updated; the latest release was on June 24, 2023, and the most recent update was on December 17, 2023. It is MIT-licensed and has an active Discord community.

  • SurveyJS

    Open-Source JSON Form Builder to Create Dynamic Forms Right in Your App. With SurveyJS form UI libraries, you can build and style forms in a fully-integrated drag & drop form builder, render them in your JS app, and store form submission data in any backend, inc. PHP, ASP.NET Core, and Node.js.

    SurveyJS logo
  • JSDoc

    An API documentation generator for JavaScript.

  • Project mention: Eloquent JavaScript 4th edition (2024) | news.ycombinator.com | 2024-03-07

    I wholeheartedly agree. At most, I introduce JSDoc[1] to newer developers as standardising how parameters and whatnot are commented at least gets you better documentation and _some_ safety without adding any TS knowledge overhead.

    [1] https://jsdoc.app/

  • editor.md

    The open source embeddable online markdown editor (component).

  • apiDoc

    RESTful web API Documentation Generator.

  • documentation.js

    :book: documentation for modern JavaScript

  • ESDoc

    ESDoc - Good Documentation for JavaScript

  • WorkOS

    The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

    WorkOS logo
  • codecrumbs

    Learn, design or document codebase by putting breadcrumbs in source code. Live updates, multi-language support and more.

  • dox

    JavaScript documentation generator for node using markdown and jsdoc

  • Documize

    Modern Confluence alternative designed for internal & external docs, built with Go + EmberJS (by documize)

  • Project mention: Looking for collaboration platform (preferably open source, alternative to Confluence) | /r/selfhosted | 2023-05-06

    You could try Documize https://github.com/documize/community

  • widdershins

    OpenAPI / Swagger, AsyncAPI & Semoasa definitions to (re)Slate compatible markdown

  • Project mention: Been working on a tutorial to help indies make scalable multiplayer games, looking for feedback before I officially share | /r/IndieDev | 2023-04-26

    You may want to look into other tooling to redesign your Swagger into easier to follow documentation such as: https://github.com/Mermade/widdershins

  • styledocco

    Automatically generate a style guide from your stylesheets.

  • spectaql

    Autogenerate static GraphQL API documentation

  • Project mention: What software do you use to write documentation? | /r/learnprogramming | 2023-04-27

    I've also used spectaql before to auto generate graphql docs.

  • retype

    Retype is an ✨ ultra-high-performance✨ static site generator that builds a website based on simple text files.

  • Project mention: MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust | news.ycombinator.com | 2023-06-29
  • documentation

    Strapi Documentation (by strapi)

  • fastify-swagger

    Swagger documentation generator for Fastify

  • Project mention: Craft OpenAPI Specs & Production-Ready SDKs with Fastify | dev.to | 2023-11-09

    With Speakeasy, you can create client SDKs based on an OpenAPI specification. Fastify ships with the @fastify/swagger plugin, which provides convenient shortcuts for generating good OpenAPI specifications. We'll start this tutorial by registering @fastify/swagger in a Fastify project to generate a spec.

  • generator

    Use your AsyncAPI definition to generate literally anything. Markdown documentation, Node.js code, HTML documentation, anything!

  • Project mention: AsyncAPI Codegen, a code generator from AsyncAPI spec v2 and v3. | dev.to | 2024-03-06

    For that, the project provides a Javascript tool to generate source code from specification in numerous languages: Python, Java, Markdown, PHP, … and even Go! All you have to do is install the corresponding NPM packages and launch the right command tool.

  • rabbitmq-website

    RabbitMQ website

  • Project mention: How to Build & Deploy Scalable Microservices with NodeJS, TypeScript and Docker || A Comprehesive Guide | dev.to | 2024-01-25

    RabbitMQ comes with administrative tools to manage user permissions and broker security and is perfect for low latency message delivery and complex routing. In comparison, Apache Kafka architecture provides secure event streams with Transport Layer Security(TLS) and is best suited for big data use cases requiring the best throughput.

  • metamask-docs

    Developer documentation for MetaMask

  • insomnia-documenter

    Tool to create minimalist and beautiful API documentation pages using your Insomnia workspace export file.

  • opentelemetry.io

    The OpenTelemetry website and documentation

  • Gitdown

    GitHub markdown preprocessor.

  • InfluxDB

    Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

    InfluxDB logo
NOTE: The open source projects on this list are ordered by number of github stars. The number of mentions indicates repo mentiontions in the last 12 Months or since we started tracking (Dec 2020).

JavaScript Documentation related posts

Index

What are some of the best open-source Documentation projects in JavaScript? This list will help you:

Project Stars
1 mermaid 66,838
2 docsify 26,611
3 JSDoc 14,742
4 editor.md 13,562
5 apiDoc 9,721
6 documentation.js 5,761
7 ESDoc 2,745
8 codecrumbs 2,687
9 dox 2,155
10 Documize 2,065
11 widdershins 1,456
12 styledocco 1,069
13 spectaql 1,044
14 retype 972
15 documentation 926
16 fastify-swagger 851
17 generator 730
18 rabbitmq-website 673
19 metamask-docs 611
20 insomnia-documenter 484
21 opentelemetry.io 464
22 Gitdown 448
23 docusaurus-lunr-search 431

Sponsored
Power Real-Time Data Analytics at Scale
Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.
www.influxdata.com