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: Integrate Ory in a NestJS application | dev.to | 2024-05-16

    To visualize the user flow for the CatFoster project, we will create a series of diagrams using Mermaid to illustrate the different user interactions within the system. These interactions include signing up and signing in, creating a cat profile, updating and deleting their cat profiles, requesting to foster a cat, and approving fostering requests.

  • 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: How to document your JavaScript package | dev.to | 2024-05-17

    Thanks to JSDoc it's easy to write documentation that is coupled with your code and can be consumed by users in a variety of formats. When combined with a modern publishing flow like JSR, you can easily create comprehensive documentation for your package that not only fits within your workflow, but also integrates directly in the tools your users consume your package with. This blog post aims to cover best practices when writing JSDoc-style comments to get your users up and running as quickly as possible:

  • 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

  • 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
  • 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)

  • widdershins

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

  • styledocco

    Automatically generate a style guide from your stylesheets.

  • spectaql

    Autogenerate static GraphQL API documentation

  • retype

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

  • Project mention: Retype | news.ycombinator.com | 2024-05-22
  • documentation

    Strapi Documentation (by strapi)

  • Project mention: Deploy Strapi as a Content Backend and Headless CMS | dev.to | 2024-05-27

    Set the variable values to reference your own information as follows: - `HOST`: Set to `0.0.0.0`. This tells Strapi to listen for connections on all interfaces. - `NODE_ENV`: Set to `production`. This disables development-only features and enables our production-specific configuration. - `DATABASE_CLIENT`: Set to `postgres` to use a PostgreSQL database instead of a local SQLite database. - `DATABASE_URL`: The connection string to connect to and authenticate with the PostgreSQL database. Set this to the `psql` connection string you copied from your Koyeb database detail page and append `?ssl_mode=require` to the end to force the connection to use TLS/SSL. - `S3_ENDPOINT`: The object storage bucket endpoint URL. Enter the "Endpoint" value you copied from Backblaze B2 (this should not include a protocol specification). - `S3_REGION`: The region where the object storage bucket is hosted. Enter the region embedded in the endpoint URL. For instance if the `S3_ENDPOINT` is `s3.eu-central-003.backblazeb2.com`, the `S3_REGION` should be set to `eu-central-003`. - `S3_BUCKET`: The name of your object storage bucket. Enter the bucket name copied from Backblaze B2. - `S3_ACCESS_KEY_ID`: The key ID to use when authenticating to Backblaze B2. Enter the `keyID` for the API key that you created in Backblaze. - `S3_ACCESS_SECRET`: The secret key to use when authenticating to Backblaze B2. Enter the `applicationKey` for the API key that you created in Backblaze. - `APP_KEYS`: A comma-separated list of application keys to be used by middleware. Generate these with `openssl rand -base64 32`. For example, to set two keys, it might look like: `APP_KEYS=,`. - `API_TOKEN_SALT`: The salt used to generate new API keys. Generate with `openssl rand -base64 32`. - `JWT_SECRET`: A random string used to create new JSON Web Tokens (JWT). Generate with `openssl rand -base64 32`. - `ADMIN_JWT_SECRET`: A separate random string used to create new JSON Web Tokens (JWT) for the admin panel. Generate with `openssl rand -base64 32`. - `TRANSFER_TOKEN_SALT`: A salt used to generate [transfer tokens](https://docs.strapi.io/dev-docs/data-management/transfer#generate-a-transfer-token). Generate with `openssl rand -base64 32`. 4. In the **Instance** section, select the **Eco** category and choose **eMedium** or larger. Strapi [recommends a single core and 2GB of memory](https://docs.strapi.io/dev-docs/deployment#hardware-and-software-requirements) at a minimum. 5. Click **Deploy**. Koyeb will pull your application repository and then build and run it according to the `build` and `start` scripts found in the `package.json` file. During deployment, Strapi will create the appropriate data structures in the database according to the schema files generated by our content type definitions. ## Create a production administration account and test functionality Once the deployment is complete, access your Strapi instance by visiting your Koyeb deployment URL. The application URL should have the following format:

  • 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: a practical look | dev.to | 2024-05-03

    The "most official" AsyncAPI generator linked from the AsyncAPI site will follow the references in the "allOf" structure to generate the subclasses of the Pet class. But it will ignore the "discriminator" logic and actually fail because it does know what to do with the "petType" attribute repeated in the derived types (e.g. StickInsect).

  • 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.

  • SaaSHub

    SaaSHub - Software Alternatives and Reviews. SaaSHub helps you find the best software and product alternatives

    SaaSHub 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

  • Retype

    1 project | news.ycombinator.com | 22 May 2024
  • How to document your JavaScript package

    3 projects | dev.to | 17 May 2024
  • Deep Dive: Google Apps Script - Testing APIs and Automating Sheets

    1 project | dev.to | 15 May 2024
  • Show HN: Collaborative, text-based technical diagramming tool

    1 project | news.ycombinator.com | 8 May 2024
  • Figma's Journey to TypeScript

    5 projects | news.ycombinator.com | 4 May 2024
  • The origin and virtues of semicolons in programming languages

    2 projects | news.ycombinator.com | 15 Apr 2024
  • ChatCraft Adventures #13, UI Changes

    3 projects | dev.to | 12 Apr 2024
  • A note from our sponsor - SurveyJS
    surveyjs.io | 29 May 2024
    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. Learn more →

Index

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

Project Stars
1 mermaid 67,787
2 docsify 26,778
3 JSDoc 14,801
4 editor.md 13,613
5 apiDoc 9,722
6 documentation.js 5,765
7 ESDoc 2,745
8 codecrumbs 2,687
9 dox 2,155
10 Documize 2,080
11 widdershins 1,461
12 styledocco 1,069
13 spectaql 1,050
14 retype 994
15 documentation 957
16 fastify-swagger 864
17 generator 742
18 rabbitmq-website 705
19 metamask-docs 623
20 insomnia-documenter 486
21 opentelemetry.io 473
22 Gitdown 450
23 docusaurus-lunr-search 440

Sponsored
SaaSHub - Software Alternatives and Reviews
SaaSHub helps you find the best software and product alternatives
www.saashub.com