If you are interested in contributing to the development of the manual or in helping fixup the api documentation as we move from yuidocs => tsdoc+typedoc, instructions here: docs.warp-drive.io/guide/contri...
WarpDrive
WarpDrive is a lightweight data library for web apps — universal, typed, reactive, and ready to scale.
docs.warp-drive.io
May 15, 2025 at 8:41 AM
If you are interested in contributing to the development of the manual or in helping fixup the api documentation as we move from yuidocs => tsdoc+typedoc, instructions here: docs.warp-drive.io/guide/contri...
So far extremely impressed with vitepress (and some of the plugins for it).
So far extremely unimpressed by typedoc.
Why does it feel like yuidoc sucked and no tool since has done even 2% better?
So far extremely unimpressed by typedoc.
Why does it feel like yuidoc sucked and no tool since has done even 2% better?
May 13, 2025 at 11:08 PM
So far extremely impressed with vitepress (and some of the plugins for it).
So far extremely unimpressed by typedoc.
Why does it feel like yuidoc sucked and no tool since has done even 2% better?
So far extremely unimpressed by typedoc.
Why does it feel like yuidoc sucked and no tool since has done even 2% better?
has so many knock-on effects to. Want to use api-extractor? nope. Want to use typedoc? nope. Then we end up with a dozen different hard-to-maintain tooling ecosystems for each extension that could have just been one liners if there were a decent plugin api.
github.com/TypeStrong/t...
github.com/TypeStrong/t...
Support .d.ts entryPoints · Issue #1887 · TypeStrong/typedoc
Search Terms entryPoints Problem Vue use vue-tsc to convert .vue file to .d.ts declarations. But typedoc not support .d.ts file as entryPoints Suggested Solution Support .d.ts files as entryPoints.
github.com
May 13, 2025 at 11:03 PM
has so many knock-on effects to. Want to use api-extractor? nope. Want to use typedoc? nope. Then we end up with a dozen different hard-to-maintain tooling ecosystems for each extension that could have just been one liners if there were a decent plugin api.
github.com/TypeStrong/t...
github.com/TypeStrong/t...
honestly the typescript team should probably fix this in the JS version prior to shipping the rust version. Without a fix frameworks like vue/svelte/ember have to do crazy hacks to make projects like `typedoc` that expect to just invoke tsc work.
May 13, 2025 at 9:45 PM
honestly the typescript team should probably fix this in the JS version prior to shipping the rust version. Without a fix frameworks like vue/svelte/ember have to do crazy hacks to make projects like `typedoc` that expect to just invoke tsc work.
renovate bot opened a pull request in bryopsida/crypto renovate[bot] bot opened bryopsida/crypto#...
https://github.com/bryopsida/crypto/pull/440
Result Details
https://github.com/bryopsida/crypto/pull/440
Result Details
Update dependency typedoc to v0.28.4 by renovate[bot] · Pull Request #440 · bryopsida/crypto
This PR contains the following updates: Package Change Age Adoption Passing Confidence typedoc (source) 0.28.3 -> 0.28.4 Release Notes TypeStrong/TypeDoc (typedoc) v0.28.4 Compar...
github.com
May 4, 2025 at 1:41 AM
renovate bot opened a pull request in bryopsida/crypto renovate[bot] bot opened bryopsida/crypto#...
https://github.com/bryopsida/crypto/pull/440
Result Details
https://github.com/bryopsida/crypto/pull/440
Result Details
Was curious for other folks doing design systems if you have a good way to get the TypeScript types for your package and components in it? 👀 Have been trying to look into different tools (api extractor, typedoc, docgen, etc) for this but nothing seems to quite cover everything yet.
November 8, 2024 at 4:51 PM
Was curious for other folks doing design systems if you have a good way to get the TypeScript types for your package and components in it? 👀 Have been trying to look into different tools (api extractor, typedoc, docgen, etc) for this but nothing seems to quite cover everything yet.
I wish the TypeDoc API reference were better organized - particularly that "Other" section here api.reactrouter.com/v7/modules/r...
I wish more of the Remix guides were moved over.
Provide more context and mental models for principles. I don't know why this was chopped github.com/remix-run/re...
I wish more of the Remix guides were moved over.
Provide more context and mental models for principles. I don't know why this was chopped github.com/remix-run/re...
react-router | React Router API Reference
Documentation for React Router API Reference
api.reactrouter.com
December 19, 2024 at 2:51 PM
I wish the TypeDoc API reference were better organized - particularly that "Other" section here api.reactrouter.com/v7/modules/r...
I wish more of the Remix guides were moved over.
Provide more context and mental models for principles. I don't know why this was chopped github.com/remix-run/re...
I wish more of the Remix guides were moved over.
Provide more context and mental models for principles. I don't know why this was chopped github.com/remix-run/re...
TypeDoc: testing code examples in doc comments
TypeDoc: testing code examples in doc comments
TypeDoc now lets us refer to parts of other files via {@includeCode}. In this blog post, I explain how that works and why it’s useful.
buff.ly
March 13, 2025 at 2:51 AM
TypeDoc: testing code examples in doc comments
For publishing modules, you already build out these .d.ts files so this isn’t a big deal, but for project code you would need to set this up. Typedoc could also probably improve this use case directly easily if they were open to it.
December 28, 2024 at 5:32 PM
For publishing modules, you already build out these .d.ts files so this isn’t a big deal, but for project code you would need to set this up. Typedoc could also probably improve this use case directly easily if they were open to it.
I was able to get the typedoc tool working with ts-in-js patterns by running with the js types built out to .d.ts files and then running typedoc on those assets.
December 28, 2024 at 5:31 PM
I was able to get the typedoc tool working with ts-in-js patterns by running with the js types built out to .d.ts files and then running typedoc on those assets.
March 12, 2024 at 3:08 PM
is there an eslint rule or something that fails if your api surface refers to a symbol that isn't exported
short of just running typedoc and checking for warnings I guess
short of just running typedoc and checking for warnings I guess
September 19, 2024 at 1:42 PM
is there an eslint rule or something that fails if your api surface refers to a symbol that isn't exported
short of just running typedoc and checking for warnings I guess
short of just running typedoc and checking for warnings I guess
Learning to bend TypeDoc to my will for Leaf & Roomy:
- muni-town.github.io/leaf/
- muni-town.github.io/roomy-sdk/
A little less than obvious how to get it setup nice, but overall not bad and you can get some pretty good results.
- muni-town.github.io/leaf/
- muni-town.github.io/roomy-sdk/
A little less than obvious how to get it setup nice, but overall not bad and you can get some pretty good results.
TypeDoc
Documentation for TypeDoc
typedoc.org
March 17, 2025 at 4:26 PM
Learning to bend TypeDoc to my will for Leaf & Roomy:
- muni-town.github.io/leaf/
- muni-town.github.io/roomy-sdk/
A little less than obvious how to get it setup nice, but overall not bad and you can get some pretty good results.
- muni-town.github.io/leaf/
- muni-town.github.io/roomy-sdk/
A little less than obvious how to get it setup nice, but overall not bad and you can get some pretty good results.
Making TypeDoc better via @sitepen
November 19, 2024 at 11:56 AM
Making TypeDoc better via @sitepen
Hello twitter, what are the best tools for documenting an #angular2 app ? (code & app behaviors) dgeni + typedoc ? @manekinekko any idea ?
November 19, 2024 at 11:46 AM
Hello twitter, what are the best tools for documenting an #angular2 app ? (code & app behaviors) dgeni + typedoc ? @manekinekko any idea ?
I use a combination of typedoc (for generating markdown from jsdoc & types) and astro starlight (for page structure and handwritten content, but it's not ideal. Interested to hear what solutions other folk are using.
March 22, 2025 at 5:45 AM
I use a combination of typedoc (for generating markdown from jsdoc & types) and astro starlight (for page structure and handwritten content, but it's not ideal. Interested to hear what solutions other folk are using.
Tried Storybook first, but it didn't play nicely with the @solidjs.com package in the monorepo. Decided to instead try a combinaton of Astro's starlight for the website, typedoc for auto-generating the content and a bit of custom logic (e.g. a wrapper for live-testing components).
March 1, 2025 at 10:39 PM
Tried Storybook first, but it didn't play nicely with the @solidjs.com package in the monorepo. Decided to instead try a combinaton of Astro's starlight for the website, typedoc for auto-generating the content and a bit of custom logic (e.g. a wrapper for live-testing components).
Sure, Lachlan has set it up in every other repo, but we should be able to copy the typedoc configs over to query if they're not already there
April 29, 2025 at 12:58 PM
Sure, Lachlan has set it up in every other repo, but we should be able to copy the typedoc configs over to query if they're not already there
The TanStack Pacer docs source of truth is all in the JS doc, and then markdown gets generated by typedoc for the website docs. I never want to write API docs another way again. We will always have carefully written guides on the docs site to supplement though.
April 28, 2025 at 9:32 PM
The TanStack Pacer docs source of truth is all in the JS doc, and then markdown gets generated by typedoc for the website docs. I never want to write API docs another way again. We will always have carefully written guides on the docs site to supplement though.
📝 Summary:
TSDocs.dev is a service that allows users to browse type reference documentation for JavaScript packages, even if they are not written in TypeScript. It relies on a customized version of typedoc to generate API documentation. The service extracts documentation from type (1/2)
TSDocs.dev is a service that allows users to browse type reference documentation for JavaScript packages, even if they are not written in TypeScript. It relies on a customized version of typedoc to generate API documentation. The service extracts documentation from type (1/2)
December 21, 2023 at 7:50 PM
📝 Summary:
TSDocs.dev is a service that allows users to browse type reference documentation for JavaScript packages, even if they are not written in TypeScript. It relies on a customized version of typedoc to generate API documentation. The service extracts documentation from type (1/2)
TSDocs.dev is a service that allows users to browse type reference documentation for JavaScript packages, even if they are not written in TypeScript. It relies on a customized version of typedoc to generate API documentation. The service extracts documentation from type (1/2)
Finally, TypeDoc has been invaluable for generating clean, easy-to-navigate docs that deploy quickly to @github.com Pages and auto-update with code changes. Documentation done right makes any library far easier to use and maintain. 💻✨
github.com/TypeStrong/t...
#Documentation #FrontendDev #VueJS
github.com/TypeStrong/t...
#Documentation #FrontendDev #VueJS
GitHub - TypeStrong/typedoc: Documentation generator for TypeScript projects.
Documentation generator for TypeScript projects. Contribute to TypeStrong/typedoc development by creating an account on GitHub.
github.com
November 12, 2024 at 12:40 PM
Finally, TypeDoc has been invaluable for generating clean, easy-to-navigate docs that deploy quickly to @github.com Pages and auto-update with code changes. Documentation done right makes any library far easier to use and maintain. 💻✨
github.com/TypeStrong/t...
#Documentation #FrontendDev #VueJS
github.com/TypeStrong/t...
#Documentation #FrontendDev #VueJS