tsdoc
redoc
Our great sponsors
tsdoc | redoc | |
---|---|---|
15 | 35 | |
4,655 | 22,515 | |
1.1% | 1.9% | |
6.1 | 7.9 | |
18 days ago | 2 days 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?
redoc
-
Best Software Documentation Tools
ReDoc Interactive Demo
-
Effortless API Documentation: Accelerating Development with FastAPI, Swagger, and ReDoc
ReDoc focuses on simplicity and readability, presenting the API documentation in a user-friendly format. It supports dark mode, multiple languages, and offers a seamless browsing experience for API consumers.
-
Show HN: I’m building open-source headless CMS for technical content
There are a few other tools out there that are at least marginally better than the default Swagger UI such as ReDoc (https://github.com/Redocly/redoc).
When we redid the Mux docs (https://docs.mux.com/api-reference) we actually just decided to build our own renderer. It really wasn't as bad as you might think, at build time we pull in the JSON version of our OAS spec and render it as a static build in our Nextjs app. Don't get me wrong, it wasn't trivial, but the benefit of having complete control over the output has been well worth it.
-
How to Connect a FastAPI Server to PostgreSQL and Deploy on GCP Cloud Run
Redoc: http://localhost:8080/redoc
-
The Best API Documentation Tools for Dev Teams in 2023
ReDoc is a tool that's similar to Swagger UI. It also takes an OAS and renders an interactive HTML page with full API documentation details; however, it has a notable difference.
-
In what cases do you use OpenAPI/Swagger code generator on front-end using files provided by backend developers?
take a look
- Alguma alma caridosa UI/UX dev, para um serviço púbico gratuito, livre e de código aberto?
-
Hacktoberfest 2022: 7 Open Source Projects to Contribute to
Redoc is an open source tool to generate API reference documentation websites from OpenAPI definitions.
-
How to find an open source ready front-end that needs a backend to get running?
FastAPI for Python has an awesome way of doing this. It comes with two choices: Swagger and Redoc, the former being more interactive while the latter is (IMO) more visually appealing. I'm sure you could implement one of these using Spring.
-
Starlite new features, benchmarks and a call for contributors and maintainers
Starlite has substantially enhanced OpenAPI (3.1) documentation - in fact, its the most complete autogenerated schema around, and it ships with Redoc, Swagger-UI and Stoplight-Elements static sites.
What are some alternatives?
typedoc - Documentation generator for TypeScript projects.
slate - Beautiful static documentation for your API
vscode-docthis - JSDoc generator extension for Visual Studio Code.
swagger-ui - Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
compodoc - :notebook_with_decorative_cover: The missing documentation tool for your Angular, Nest & Stencil application
Docusaurus - Easy to maintain open source documentation websites.
vim-doge - (Do)cumentation (Ge)nerator for nearly 20 languages 📚 Generate proper code documentation with a single keypress. ⚡️🔥
elements - Build beautiful, interactive API Docs with embeddable React or Web Components, powered by OpenAPI and Markdown.
tree-sitter-comment - Tree-sitter grammar for comment tags like TODO, FIXME(user).
mkdocs
ts-morph - TypeScript Compiler API wrapper for static analysis and programmatic code changes.
postman-app-support - Postman is an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIs—faster.