tsdoc
extractor
tsdoc | extractor | |
---|---|---|
15 | 2 | |
4,658 | 11 | |
0.5% | - | |
5.7 | 9.7 | |
9 days ago | 9 days ago | |
TypeScript | TypeScript | |
MIT License | GNU Affero General Public License v3.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
tsdoc
-
Jsdoc Cheatsheet
For what it’s worth, there’s also TSDoc[1] which is TypeScript’s sorta-equivalent spiritual successor, and notably uses the same format as JSDoc. Inline type annotation is great—and I vastly prefer it to JSDoc as a type annotation mechanism—but supporting the breadth of documentation capability in an inline code position would probably be unwieldy no matter how you try to accommodate it.
1: https://tsdoc.org/
-
What am I Missing (or Could Benefit From Using) For My Stack?
Docs? TSdoc + TypeDoc or DocFX. Of particular interest, this can be used to generate JSON schema's, useful for REST / GraphQL
-
Complete rewrite of ESLint (GitHub discussion by the creator)
Nope, they look the same, at a glance, but they're not the same. JSDoc and TSDoc are different standards, developed by different teams.
- tsc doesn't convert jsdoc types into real typescript
-
How to properly document components
JSDoc is a terrible standard. I would rather go for TypeScript + TSDoc, then use TypDoc to generate the actual documentation based on TS typings. Alternatively, you can go for Vue Styleguidist. It's an excellent tool, but, opposite to TSDoc it's not a standard, it's just a tool.
-
Using @microsoft/tsdoc for documenting functions
I am trying to use the @microsoft/tsdoc package to generate documentation for a given file. I followed the demo that hey have provided https://github.com/microsoft/tsdoc/tree/main/api-demo and it works for the sample input they provided, shown below.
-
Is it better to use the JSDoc return type or TypeScript return type?
Maybe this is of interest? https://tsdoc.org/
- TSDoc – Documentation Your TypeScript in Code
-
Neogen - The annotation toolkit you never knew you needed
Awesome, thank you! Would you be willing to support TSDoc ?
- Do you use JSdocs with TypeScript?
extractor
-
I made a website that documents TypeScript packages
The declarations (functions, variables, classes ...) and their docs are extracted with a custom API extractor I built based on the ts-morph library and the TypeScript compiler.
-
Show HN: Automatic Documentation for TypeScript Packages
Thank you for your question, I don't have experience with Docusaurus but I'll try to list a few ideas, let me know if it can help you.
If you only need raw package metatada (signatures, docs...) that Docusaurus will render somehow at build time you may use my extractor which outputs a plain Javascript object with the collected information (see https://github.com/jsdocs-io/extractor/blob/main/test/packag...).
If you need pre-rendered docs that Docusaurus will embed in a page you may implement something like a React component (see https://github.com/jsdocs-io/web/blob/main/src/components/pa...) and use the raw metadata as component props.
If you need a pre-rendered page that Docusaurus will collect, you may want to look into https://www.npmjs.com/package/@microsoft/api-extractor which can directly output Markdown files (as well as JSON files) but requires some initial setup to get working.
What are some alternatives?
typedoc - Documentation generator for TypeScript projects.
smartblock - intuitive block based wysiwyg editor built with React and ProseMirror
vscode-docthis - JSDoc generator extension for Visual Studio Code.
ts-morph - TypeScript Compiler API wrapper for static analysis and programmatic code changes.
compodoc - :notebook_with_decorative_cover: The missing documentation tool for your Angular, Nest & Stencil application
open-source - Open Source Angular Libraries contributed by @myndpm
redoc - 📘 OpenAPI/Swagger-generated API Reference Documentation
mailgo - 💌 mailgo, a new concept of mailto and tel links [deprecated]
vim-doge - (Do)cumentation (Ge)nerator for nearly 20 languages 📚 Generate proper code documentation with a single keypress. ⚡️🔥
web - jsDocs.io is an open source documentation host for Javascript and Typescript packages.
tree-sitter-comment - Tree-sitter grammar for comment tags like TODO, FIXME(user).
rushstack - Monorepo for tools developed by the Rush Stack community