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: Advice on starting a design system / component library | reddit.com/r/FigmaDesign | 2023-01-31

    Have you explored using storybook ? I've seen it be really helpful for these types of challenges if incrementally adopted.

  • Docusaurus

    Easy to maintain open source documentation websites.

    Project mention: Rendering Frameworks JavaScript | dev.to | 2023-01-31

    Docusaurus is a tool designed to make it easy for teams to publish documentation websites without having to worry about the infrastructure and design details. https://docusaurus.io/

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

  • docz

    ✍ It has never been so easy to document your things!

    Project mention: Why aren't Node.js package managers interoperable? | dev.to | 2022-10-07

    This is a real concern. I've worked on some Yarn projects where I sometimes forget and accidentally run npm. Although these package managers (I'll call them PMs for short) are interoperable to some degree, there are important differences between these tools, so you should know what you're getting into. Even in seemingly simple projects, results can vary. Here are two reports of things working with one PM, but not another. Moreso, running install once is very different from continuous concurrent use, where you're adding and removing packages and more.

  • TOAST UI Editor

    🍞📝 Markdown WYSIWYG Editor. GFM Standard + Chart & UML Extensible.

    Project mention: Is there a way to edit callouts in preview mode | reddit.com/r/ObsidianMD | 2023-01-30

    - Toast UI Editor: https://ui.toast.com/tui-editor

  • mkdocs-material

    Documentation that simply works

    Project mention: Working docker-compose.yml file for mkdocs-material? | reddit.com/r/selfhosted | 2023-01-29

    Does anyone have a working docker-compose file for Mkdocs-Material?

  • react-styleguidist

    Isolated React component development environment with a living style guide

    Project mention: Building a design system with Radix | dev.to | 2022-10-14

    Because documentation is so important, our sample project has been preconfigured with React Styleguidist, a development environment for building React components. We’ll use this tool to document the components as we build them out.

  • reactjs.org

    The React documentation website

    Project mention: Dan Abramov discusses create-react-app's future | news.ycombinator.com | 2023-01-31

    More specifically, the comment: https://github.com/reactjs/reactjs.org/pull/5487#issuecommen...

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

  • typedoc

    Documentation generator for TypeScript projects.

    Project mention: Complete rewrite of ESLint (GitHub discussion by the creator) | reddit.com/r/javascript | 2022-11-25

    TSDoc is more consistent, has cleaner documentation, better tooling (e.g. TypeDoc or ESLint plugin) and better support for data structures (e.g. straightforward enums support).

  • markdoc

    A powerful, flexible, Markdown-based authoring framework.

    Project mention: How to create documentation site | reddit.com/r/nextjs | 2023-01-19

    Hola. Former Stripe employee here - they use Markdoc: https://markdoc.dev/

  • tsdoc

    A doc comment standard for TypeScript

    Project mention: What am I Missing (or Could Benefit From Using) For My Stack? | reddit.com/r/webdev | 2022-11-29

    Docs? TSdoc + TypeDoc or DocFX. Of particular interest, this can be used to generate JSON schema's, useful for REST / GraphQL

  • compodoc

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

    Project mention: The best Angular 15 Starter Project | dev.to | 2022-12-26

    ✅ Angular 15 ✅ Angular Material ✅ Unit Testing with Jest ✅ End-to-End Testing with [TestCafé](https://testcafe.io/ ✅ Internationalization with Transloco ✅ Auto documentation with Compodoc ✅ Analyse your project with webpack-bundle-analyzer ✅ Docker ✅ ESLint ✅ Prettier ✅ Commit Linting ✅ AuditJS Audit this application using Sonatype OSS Index ✅ Auto-generate a CHANGELOG with auto-changelog

  • react-docgen

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

    Project mention: why use a variable in this code? | reddit.com/r/reactjs | 2022-12-31

    saw this code on the react-docgen repo source

  • docsearch

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

    Project mention: Easy Way to Integrate Algolia to VuePress Application | dev.to | 2022-10-30

    First, register with Algolia. Then you need to upload the document information in VuePress application to Algolia. DocSearch provides a crawler and UI to easily crawl index information and upload it. However, you need to meet certain conditions to apply for this service. Fortunately, the old version of DocSearch provided a solution to run the crawler yourself. So I ended up with the Run Your Own solution.

  • sandpack

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

    Project mention: Creating fluffy trees with Three.js | reddit.com/r/web_design | 2022-12-27

    https://sandpack.codesandbox.io/ Sandpack is what they're using. Go check out the docs, and I'm sure there's plenty of tutorials if you search it up

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

  • vue-styleguidist

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

    Project mention: Vue 3 comp api autogenerated component docs | reddit.com/r/vuejs | 2022-11-15

    Yeah there’s a recent issue with the main docblock not being detected when using

  • ladle

    🥄 Develop, test and document your React story components faster.

    Project mention: Component development with ladle and next/image | dev.to | 2023-01-30

    After another look at issue #100, we can tell next/image that it should skip the optimization if the component is rendered in Ladle. That is fine, because the bandwidth does not play a big role during the development. With the following code placed inside .ladle/components.tsx ...

  • graphdoc

    Static page generator for documenting GraphQL Schema

    Project mention: magidoc alternatives - dociql and graphdoc | libhunt.com/r/magidoc | 2022-08-04

    Graphdoc is an alternative to Magidoc

  • Optic

    Optic makes it easy to document your APIs, prevent breaking changes, and follow an API style-guide

  • README

    :wave: - The documentation for being an Artsy Engineer

    Project mention: Artsy Engineering Handbook | news.ycombinator.com | 2023-01-06

    Joey who opened https://github.com/artsy/README/issues/427 is one of the best 10x engineers I’ve ever had the privilege to work with. If it’s important to him to rename all branches from “master” to “joey” I’d add my plus 1.

    Jokes aside, please read Ash’s (another artsy alumni) post on psychological safety, hope it changes your mind: https://ashfurrow.com/blog/building-compassionate-software/

  • docs.nestjs.com

    The official documentation https://docs.nestjs.com 📕

    Project mention: Example of how to use a TypeORM custom repository (uptodate) | reddit.com/r/Nestjs_framework | 2022-06-23

    When TypeORM release version v0.3.0 it breaks somethings including custom repositories, this later cause that Custom Repository were deleted from the official documentation.

  • md-to-pdf

    Hackable CLI tool for converting Markdown files to PDF using Node.js and headless Chrome.

    Project mention: Convert Markdown format files to PDF files (mermaid/emoji/toc compatible) | dev.to | 2022-09-01

    I could have used md-to-pdf, but it seemed like it would take a little time, so I implemented it as quickly as possible, like a hackathon. I wanted to, so I decided to use a library called md-to-pdf-ng.

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

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 76,268
2 Docusaurus 41,756
3 docz 23,097
4 TOAST UI Editor 15,599
5 mkdocs-material 12,532
6 react-styleguidist 10,571
7 reactjs.org 8,476
8 typedoc 6,385
9 markdoc 5,861
10 tsdoc 4,266
11 compodoc 3,770
12 react-docgen 3,352
13 docsearch 3,177
14 sandpack 2,970
15 express-typescript-boilerplate 2,836
16 try 2,541
17 vue-styleguidist 2,323
18 ladle 1,955
19 graphdoc 1,493
20 Optic 1,060
21 README 998
22 docs.nestjs.com 794
23 md-to-pdf 771
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