Generating API documentation for TypeScript packages with TypeDoc

Better documentation to better serve users of your package

David Herron
ITNEXT
Published in
10 min readMar 12, 2022

--

With TypeDoc, one adds structured comments (JSDoc style comments) to TypeScript source code. With data in those comments, TypeDoc generates nice API documentation you can easily publish to a website. With the addition of another tool, gh-pages, it is easy

--

--

Software Engineer and author (Node.js Web Development and more) passionate about Node.js, climate change, EV’s, and clean energy. https://davidherron.com