The TypeScript documenter that meets you where you are
This repository is a monorepo. Here is the package breakdown.
| On npm | In monorepo | Purpose |
|---|---|---|
| N/A | packages/web |
The web app hosted at tydoc.vercel.app. Since this is not a consumable package with an interface it is not published on npm. |
tydoc |
packges/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 |
packges/extractor |
The @tydoc/extractor package is a library for getting the extracted documentation data (EDD). |
@tydoc/renderer |
packges/renderer-markdown |
The @tydoc/renderer-markdown package is a library for transforming EDD into a Markdown document. |
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. We envision a better way to document TypeScript packages that approximates the standards already set by other language communities like Elm, Elixir, Haskell, Rust, and Go.