https://github.com/tydoc/tydoc

The TypeScript documenter that meets you where you are
https://github.com/tydoc/tydoc

ast automation cli documentation internal-development typescript

Last synced: 7 days ago
JSON representation

The TypeScript documenter that meets you where you are

• Host: GitHub
• URL: https://github.com/tydoc/tydoc
• Owner: tydoc
• Created: 2020-02-05T10:05:14.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2021-05-11T02:41:25.000Z (about 3 years ago)
• Last Synced: 2024-06-22T01:28:10.685Z (15 days ago)
• Topics: ast, automation, cli, documentation, internal-development, typescript
• Language: TypeScript
• Homepage: https://tydoc.vercel.app
• Size: 2.27 MB
• Stars: 28
• Watchers: 5
• Forks: 2
• Open Issues: 39
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Lists

• awesome-stars - tydoc - The TypeScript documenter that meets you where you are (TypeScript)

README

        
# TyDoc

The TypeScript documenter that meets you where you are

## Packages Overview

This repository is a monorepo. Here is the package breakdown.

| On npm                                                                      | In monorepo                                                                                        | Purpose                                                                                                                                                  |

| --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |

| N/A                                                                         | [`packages/web`](https://github.com/tydoc/tydoc/tree/main/packages/web)                            | The web app hosted at [tydoc.vercel.app](https://tydoc.vercel.app). Since this is not a consumable package with an interface it is not published on npm. |

| [`tydoc`](https://www.npmjs.com/package/tydoc)                              | [`packges/tydoc`](https://github.com/tydoc/tydoc/tree/main/packages/tydoc)                         | The `tydoc` package is an entrypoint for most people. It provides the `tydoc` CLI and re-exports APIs from packages under the `@tydoc` npm namespace.    |

| [`@tydoc/extractor`](https://www.npmjs.com/package/@tydoc/extractor)        | [`packges/extractor`](https://github.com/tydoc/tydoc/tree/main/packages/extractor)                 | The `@tydoc/extractor` package is a library for getting the extracted documentation data (EDD).                                                          |

| [`@tydoc/renderer`](https://www.npmjs.com/package/@tydoc/renderer-markdown) | [`packges/renderer-markdown`](https://github.com/tydoc/tydoc/tree/main/packages/renderer-markdown) | The `@tydoc/renderer-markdown` package is a library for transforming EDD into a Markdown document.                                                       |

## About the Project

TyDoc is an open-source project worked on by us (the core team) in our free time. We maintain a roadmap for TyDoc [as a GitHub project](https://github.com/orgs/tydoc/projects/1). We envision a better way to document TypeScript packages that approximates the standards already set by other language communities like [Elm](https://package.elm-lang.org/), [Elixir](https://hexdocs.pm/), [Haskell](https://hackage.haskell.org/packages/), [Rust](https://docs.rs/), and [Go](https://godoc.org/).