Discussions

What's the recommended way of documenting a TypeScript library in readme?

I have a library written in TypeScript and I would like to publish an API reference for it, something like the one for reactjs: https://react.dev/reference/react.

Up to now, my API reference is generated with typedoc, exported to HTML files and exposed as a web page to the public.

Our company policy is to use readme for all documentation related tasks. I tried to exported the API reference to markdown using typedoc plugin and importing it into readme, but the layout doesn't look great and is not readable at all.