tsdoc
npm-package-template
Our great sponsors
| tsdoc | npm-package-template | |
|---|---|---|
| 15 | 1 | |
| 4,655 | 5 | |
| 1.1% | - | |
| 6.1 | 0.0 | |
| 19 days ago | almost 3 years ago | |
| TypeScript | TypeScript | |
| MIT License | MIT License |
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?
npm-package-template
-
Getting started with JSDoc + Typescript + React
A template repo I've created using typedoc for docs: https://github.com/Antman261/npm-package-template
What are some alternatives?
typedoc - Documentation generator for TypeScript projects.
vscode-docthis - JSDoc generator extension for Visual Studio Code.
ts-ci - 🚀 A project starter for module publisher
compodoc - :notebook_with_decorative_cover: The missing documentation tool for your Angular, Nest & Stencil application
lodash-patterns - Small pattern matching tool using lodash
redoc - 📘 OpenAPI/Swagger-generated API Reference Documentation
cloudflare-worker-jwt - A lightweight JWT implementation with ZERO dependencies for Cloudflare Workers.
vim-doge - (Do)cumentation (Ge)nerator for nearly 20 languages 📚 Generate proper code documentation with a single keypress. ⚡️🔥
tree-sitter-comment - Tree-sitter grammar for comment tags like TODO, FIXME(user).
ts-morph - TypeScript Compiler API wrapper for static analysis and programmatic code changes.
neogen - A better annotation generator. Supports multiple languages and annotation conventions.