Overview

What this library does?

This library reflects a simplified version of the TypeScript AST.

How does it benefit me?

This can help you automate the generation of a documentation website for any project you're working on. There are a lot of libraries out there that help you create static documentation websites from markdown files:

• Docusaurus
• Docsify
• GitBook
• VitePress
• Sveltepress
• Modern.js Doc
• NgDoc
• Starlight

This library can help you automate the generation of the markdown files that explain the public API of your project.

An Example:

The following example shows the information you can get from a TypeScript function.

For more examples, have a look at the playground.