TypeScript Documentation

Open-source TypeScript projects categorized as Documentation

Top 23 TypeScript Documentation Projects

  • storybook

    Storybook is a frontend workshop for building UI components and pages in isolation. Made for UI development, testing, and documentation.

  • Project mention: Storybook not picking up tailwindcss | dev.to | 2024-04-17

    [Bug]: Configuration with TailwindCss Next.js using Tailwind with Storybook

  • Docusaurus

    Easy to maintain open source documentation websites.

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

    Docusaurus is a popular open-source documentation tool primarily designed for product documentation and other technical documentation needs. It was first released in 2017 by Facebook Open Source (now Meta Open Source). Just recently, Docsaurus version 3.0 was released.

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

    The open source frontend for GitBook doc sites

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

    GitBook is a well-known online platform for developing, sharing, and publishing technical documentation. Although itโ€™s not open source, it offers free and paid plans, with the free plan having limited features and functionalities. The paid plans unlock more features, such as custom domains, team collaboration, and advanced analytics.

  • docz

    โœ It has never been so easy to document your things!

  • TOAST UI Editor

    ๐Ÿž๐Ÿ“ Markdown WYSIWYG Editor. GFM Standard + Chart & UML Extensible.

  • Project mention: I'm making a GlowUI text editor to get back into coding | /r/Windows11 | 2023-06-09

    If you need a WYSIWYG markdown editor you can try Toast UI Editor or simply use Markdown Live add-on for Visual Studio Code

  • react-styleguidist

    Isolated React component development environment with a living style guide

  • Project mention: 45 NPM Packages to Solve 16 React Problems | dev.to | 2023-11-14

    react-styleguidist

  • react.dev

    The React documentation website

  • Project mention: Is it safe to use __SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED? | news.ycombinator.com | 2024-04-02
  • 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
  • typedoc

    Documentation generator for TypeScript projects.

  • Project mention: Learn how to document JavaScript/TypeScript code using JSDoc & Typedoc | dev.to | 2024-03-02

    Firstly, install Typedoc using npm:

  • markdoc

    A powerful, flexible, Markdown-based authoring framework.

  • Project mention: Markdoc โ€“ a flexible Markdown-based authoring framework built by Stripe | news.ycombinator.com | 2024-03-06
  • tsdoc

    A doc comment standard for TypeScript

  • sandpack

    A component toolkit for creating live-running code editing experiences, using the power of CodeSandbox.

  • Project mention: Celebrating Hacktoberfest With Tips for Open-Source | dev.to | 2023-10-25

    For us at CodeSandbox, we stand by it as a company but also as individuals. We released our browser editor, Sandpack, and parts of Nodebox as open source and we want to give back any time we can!

  • compodoc

    :notebook_with_decorative_cover: The missing documentation tool for your Angular, Nest & Stencil application

  • docsearch

    :blue_book: The easiest way to add search to your documentation.

  • Project mention: Kagi Sidekick (Alpha) | news.ycombinator.com | 2024-02-20

    Great work! How it would be different from Algolia DocSearch?

    https://docsearch.algolia.com

  • react-docgen

    A CLI and library to extract information from React component files for documentation generation purposes.

  • Project mention: React how to get which props does a children need | /r/webdev | 2023-07-05

    Itโ€™s possible, assuming youโ€™ve typed your props using TS (maybe proptypes would work too, not sure) you can then use ReactDocGen (https://react-docgen.dev/) to have the types output in a way you can read them in code.

  • starlight

    ๐ŸŒŸ Build beautiful, accessible, high-performance documentation websites with Astro

  • Project mention: Setting up Doom Emacs for Astro Development | dev.to | 2024-04-23

    I've rewritten this website, my partner's website, my university rugby club's website. I'm moving my Applied Genomics course website to Starlight, the Astro team's documentation framework. The nf-core site has been rewritten in Astro and Svelte from PHP. I'm all in.

  • express-typescript-boilerplate

    A delightful way to building a RESTful API with NodeJs & TypeScript by @w3tecch

  • try

    Try .NET provides developers and content authors with tools to create interactive experiences. (by dotnet)

  • Project mention: Math.Round opens the browser print dialog (2019) | news.ycombinator.com | 2023-09-08
  • ladle

    ๐Ÿฅ„ Develop, test and document your React story components faster.

  • Project mention: PSA: Storybook sends telemetry data, opt-in by default | news.ycombinator.com | 2023-09-21
  • vue-styleguidist

    Created from react styleguidist for Vue Components with a living style guide

  • graphdoc

    Static page generator for documenting GraphQL Schema

  • Optic

    OpenAPI linting, diffing and testing. Optic helps prevent breaking changes, publish accurate documentation and improve the design of your APIs.

  • Project mention: Show HN: LintGPT โ€“ Write API Style Guides in Natural Language | news.ycombinator.com | 2023-10-25

    - Minimizing API calls. The first time you run LintGPT it is pretty slow because it has to run every rule across every part of the API specification (1000s of calls). But we shouldnโ€™t have to repeat that work. Most of the time parameters, properties, etc donโ€™t change and neither do the rules. Weโ€™re building caching into our web app to make this fast / save $ for end users.

    Happy to answer any questions. I really think thereโ€™s a huge use case here for linting all kinds of code, config, database schemas, policies in ways that were never possible before. And personally, I like the idea of having these smart tools guiding me towards making my work better vs generating it all for me โ€” idk something about that just feels good.

    [0] https://github.com/opticdev/optic

  • docs.nestjs.com

    The official documentation https://docs.nestjs.com ๐Ÿ“•

  • Project mention: Api Docs v2.0-beta prototype for NestJS ๐Ÿ˜ป ๐Ÿš€ | dev.to | 2023-07-12

    I hope you can appreciate this work started by @brunnerlivio 4 years ago and carried on by me always with his supervision ๐Ÿ™Œ, and that it can be useful during your projects with NestJS.๐Ÿ˜ป ๐Ÿ™๐Ÿป ( For more information about the "history" of this project as it started, see this PR: https://github.com/nestjs/docs.nestjs.com/pull/413)

  • README

    :wave: - The documentation for being an Artsy Engineer

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

TypeScript Documentation related posts

Index

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

Project Stars
1 storybook 82,727
2 Docusaurus 52,686
3 gitbook 26,337
4 docz 23,494
5 TOAST UI Editor 16,745
6 react-styleguidist 10,788
7 react.dev 10,667
8 typedoc 7,349
9 markdoc 6,975
10 tsdoc 4,652
11 sandpack 4,429
12 compodoc 3,952
13 docsearch 3,807
14 react-docgen 3,558
15 starlight 3,538
16 express-typescript-boilerplate 3,205
17 try 2,808
18 ladle 2,452
19 vue-styleguidist 2,437
20 graphdoc 1,536
21 Optic 1,275
22 docs.nestjs.com 1,100
23 README 1,084

Sponsored
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.com