ts-markdown is a markdown generator that removes the guesswork and provides optional TypeScript safety for data-driven markdown generation.

Try It Out

Check out the playground for a live demo and examples of using ts-markdown.

Interfaces, Types, and Functions

This documentation contains the interfaces, types, and functions that constitute the ts-markdown library. They were generated by TypeDoc, using JSDoc comments in the codebase.

If you'd like to see more information on any particular element in this documentation, open a new GitHub issue requesting the additional information.

Curated Documentation

• Cookbook: examples of ts-markdown in action
• Extending ts-markdown: info on extending ts-markdown with additional entry types and overriding existing entry types
• FAQs: frequently asked questions
• Options: more information on how options work