JavaScript Documentation

Open-source JavaScript projects categorized as Documentation

Top 23 JavaScript Documentation Projects

  • gitbook

    📝 Modern documentation format and toolchain using Git and Markdown

    Project mention: Unlimited Docs | reddit.com/r/EntrepreneurRideAlong | 2023-01-26
  • docsify

    🃏 A magical documentation site generator.

    Project mention: Docsify.js single-page apps are indexable on Google! | dev.to | 2023-01-28
  • Appwrite

    Appwrite - The Open Source Firebase alternative introduces iOS support . Appwrite is an open source backend server that helps you build native iOS applications much faster with realtime APIs for authentication, databases, files storage, cloud functions and much more!

  • electron-vue

    An Electron & Vue.js quick start boilerplate with vue-cli scaffolding, common Vue plugins, electron-packager/electron-builder, unit/e2e testing, vue-devtools, and webpack.

    Project mention: How to Use MQTT in The Electron Project | dev.to | 2022-06-19

    Address: https://github.com/SimulatedGREG/electron-vue

  • JSDoc

    An API documentation generator for JavaScript.

    Project mention: Add to array in local storage | reddit.com/r/learnjavascript | 2023-01-30

    It’s a type annotation. It’s telling you and your IDE what type the variable is. You put it on of the line you want to comment. Check it here jsdoc.

  • editor.md

    The open source embeddable online markdown editor (component).

    Project mention: Integrating Django Admin with Markdown Editor | dev.to | 2022-09-15

    Django-mdeditor is Markdown Editor plugin application for django base on Editor.md.

  • apiDoc

    RESTful web API Documentation Generator.

    Project mention: Rest API : After CRUD | dev.to | 2022-03-01

    You can find it here : https://apidocjs.com/

  • documentation.js

    :book: documentation for modern JavaScript

  • InfluxDB

    Build time-series-based applications quickly and at scale.. InfluxDB is the Time Series Platform where developers build real-time applications for analytics, IoT and cloud-native services. Easy to start, it is available in the cloud or on-premises.

  • ESDoc

    ESDoc - Good Documentation for JavaScript

    Project mention: How to properly document a React/Redux application? | reddit.com/r/codehunter | 2022-04-18

    In this post, the tool react-docgen is presented, and I have stumble upon esdoc as well. Whereas esdoc does automatic generation of documentation, react-docgen extracts the information of the React components and puts it into a JSON file.

  • 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: Recommendation for a Company-Wiki | reddit.com/r/selfhosted | 2023-01-15

    Try Documize or Ghost with a documentation theme.

  • widdershins

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

    Project mention: Generating docs from OpenAPI Spec | dev.to | 2022-04-26

    Widdershins 👎

  • styledocco

    Automatically generate a style guide from your stylesheets.

  • spectaql

    Autogenerate static GraphQL API documentation

    Project mention: Best tool for creating GraphQL API documentation? | reddit.com/r/graphql | 2022-07-17

    Other than that, SpectaQL is also a good tool that is well maintained.

  • retype

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

    Project mention: How to turn a folder of markdown docs into a structured docs section in an app? | reddit.com/r/iOSProgramming | 2022-11-29

    Outside of Swift, I use RetypeApp and they have a lot of inbuilt functionality. You can then generate your output directory on build, and use those HTML files as is.

  • fastify-swagger

    Swagger documentation generator for Fastify

    Project mention: Is NestJS good for startups? | reddit.com/r/node | 2022-11-18
  • documentation

    Strapi Documentation mono-repo (by strapi)

    Project mention: A Guide to Technical Writing | dev.to | 2022-10-11

    With practice comes perfection. The only way to be a great technical writer is to write more. The more you write, the more you learn and get better. Once you are comfortable writing for the Write For the Community program at Strapi, you may also venture into contributing to making our documentation better.

  • generator

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

    Project mention: What is AsyncAPI? | dev.to | 2022-02-16

    AsyncAPI Generator

  • rabbitmq-website

    RabbitMQ website and documentation guides

    Project mention: Rabbitmq | reddit.com/r/u_ptkrisada | 2022-02-05

    github source code

  • Gitdown

    GitHub markdown preprocessor.

  • insomnia-documenter

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

    Project mention: Basic usage of Insomnia | dev.to | 2022-09-29

    To follow the steps, you need to download insomnia-documenter first.

  • pandocs

    The single, most comprehensive Game Boy technical reference.

    Project mention: Game Boy PPU Pixel Pipeine | reddit.com/r/EmuDev | 2023-02-03

    Does anyone know of good documentation beyond: - Pan Docs - The Cycle-Accurate Game Boy Docs - Complete Technical Reference - Nitty Gritty Gameboy Cycle Timing

  • documentation

    📘 Nextcloud documentation (by nextcloud)

    Project mention: NextCloud 25 and Debian 10 (Buster) | reddit.com/r/NextCloud | 2022-12-02

    I see this change to the docs was made a month ago, but there's no explanation for the new requirement. Meanwhile I'm running NextCloud 24 on a Raspberry Pi running Buster, and I'm worried about upgrading to Bullseye because Raspberry Pi themselves don't recommend it:

  • Sonar

    Write Clean JavaScript Code. Always.. Sonar helps you commit clean code every time. With over 300 unique rules to find JavaScript bugs, code smells & vulnerabilities, Sonar finds the issues while you focus on the work.

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). The latest post mention was on 2023-02-03.

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 gitbook 25,296
2 docsify 22,642
3 electron-vue 15,173
4 JSDoc 13,452
5 editor.md 12,758
6 apiDoc 9,518
7 documentation.js 5,644
8 ESDoc 2,734
9 codecrumbs 2,642
10 dox 2,148
11 Documize 1,771
12 widdershins 1,223
13 styledocco 1,069
14 spectaql 808
15 retype 668
16 fastify-swagger 643
17 documentation 572
18 generator 563
19 rabbitmq-website 562
20 Gitdown 442
21 insomnia-documenter 436
22 pandocs 401
23 documentation 382
Write Clean JavaScript Code. Always.
Sonar helps you commit clean code every time. With over 300 unique rules to find JavaScript bugs, code smells & vulnerabilities, Sonar finds the issues while you focus on the work.
www.sonarsource.com