There are a lot of great TypeScript projects out there. The TypeScript compiler is in fact one of them. TypeDoc is another 🌹
Our goal is to provide a consolidated TypeScript experience that showcases the richness of the ecosystem and the tooling possible with the TypeScript language service. Having a great documentation browser / generator with IDE integration is just a part of that.
Issues
TypeDoc is focused on offline viewing of docs.
- We want a live documentation browser i.e. incremental generation
- Deep linking : Clicking on docs opens the code in editor tab. Looking for module documentation takes you to the documentation tab
The symbol search is a part of the solution we already have.
We also have Doctor
Lets make a new Documentation tab type. I have a few ideas around this and will share the final implementation with 💻 📷s
Votes
People seem to want this too
https://twitter.com/basarat/status/732035790855770113 🌹
More docs
High quality typedoc images : TypeStrong/typedoc#200
raw-icons.svg.zip
optimized-icons.svg.zip
Sources for typedoc themes : https://github.com/sebastian-lenz/typedoc-default-themes
Side note : All jsdoc comments should be parsed as markdown : http://typedoc.io/guides/doccomments.html
The transformers will be based losely on the typedoc converters : https://github.com/TypeStrong/typedoc/tree/53bb762ad208f2be266ece767f6204159ce71a0d/src/lib/converter/nodes
There are a lot of great TypeScript projects out there. The TypeScript compiler is in fact one of them. TypeDoc is another 🌹
Our goal is to provide a consolidated TypeScript experience that showcases the richness of the ecosystem and the tooling possible with the TypeScript language service. Having a great documentation browser / generator with IDE integration is just a part of that.
Issues
TypeDoc is focused on offline viewing of docs.
The symbol search is a part of the solution we already have.
We also have Doctor
Lets make a new Documentation tab type. I have a few ideas around this and will share the final implementation with 💻 📷s
Votes
People seem to want this too
https://twitter.com/basarat/status/732035790855770113 🌹
More docs
High quality typedoc images : TypeStrong/typedoc#200
raw-icons.svg.zip
optimized-icons.svg.zip
Sources for typedoc themes : https://github.com/sebastian-lenz/typedoc-default-themes
Side note : All jsdoc comments should be parsed as markdown : http://typedoc.io/guides/doccomments.html
The transformers will be based losely on the typedoc converters : https://github.com/TypeStrong/typedoc/tree/53bb762ad208f2be266ece767f6204159ce71a0d/src/lib/converter/nodes