-
ts-docs
A documentation generator for typescript. Generate beautiful and informative documentation with zero setup!
-
CodeRabbit
CodeRabbit: AI Code Reviews for Developers. Revolutionize your code reviews with AI. CodeRabbit offers PR summaries, code walkthroughs, 1-click suggestions, and AST-based analysis. Boost productivity and code quality across all major languages with each PR.
-
Thank you for the feedback! Yeah, I'd say that the current design wasn't really meant for viewing on mobile, and I definitely plan to make it more mobile friendly in the future, definitely check out the desktop version for the "full experience" (there's some stuff that you'll hardly notice on mobile - for example, hovering over a reference will tell you what exactly it is (class, interface, if it's external, etc.) and where it's from.). For your second bullet point, I'll definitely need to put more thought into that, seems like a pretty complex issue to handle, might need the opinion of some other people to get it going because I have no experience documenting REST APIs. As for 1.0.0, I'm 100% sure the current codebase has a ton of bugs that haven't been found by me, because the only way I test the code is by viewing the generated documentation myself - not sure how to set up tests for a documentation generator. I want to get all the bugs resolved, and possibly get more feedback from people to implement more useful features. I also have some rather big plans for ts-docs, for example, automatic documentation generation everytime a package gets published to npm, which will also automatically resolve external references from other npm-modules, think docs-rs but for typescript.
-
By the way, you people can take a look also in my documentation generation library : ts-doc-gen-md, that I created, something like 10 months ago, and see if it fits your needs. It creates documentation in github flavored markdown. I am not planning to make it create documentation in html.
Related posts
-
And so, I wrote my own Typescript Documentation Generator...
-
TypeDoc usage in @vercel/edge
-
Learn how to document JavaScript/TypeScript code using JSDoc & Typedoc
-
Document Playwright tests with typedoc
-
90% less disk space + 80% faster doc generation w/ TypeDoc. Introducing the "Default Modern Theme" for TypeDoc + complete linkable API docs for the built-in TS lib declarations.