redoc
tsdoc
Our great sponsors
redoc | tsdoc | |
---|---|---|
35 | 15 | |
22,425 | 4,645 | |
1.6% | 0.8% | |
7.5 | 6.1 | |
16 days ago | 8 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.
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.
- 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
If you want to see how Redoc will render your OpenAPI definition you can try it out online at https://redocly.github.io/redoc/.
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.
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.
-
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.
-
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?
-
TwirpScript - A simple RPC framework for JavaScript and TypeScript
Clients get in-editor API documentation. Comments in your .proto files become TSDoc comments in the generated code that will show inline documentation in supported editors.
-
Getting started with JSDoc + Typescript + React
TSDoc - Looks promising but is still in early development, and lacks many examples
-
I made a website that documents TypeScript packages
The raw JSDoc comments (for example, /** sum adds two numbers */) are parsed with tsdoc and rendered with custom React components.
-
How do you document your APIs?
I use tsdoc
What are some alternatives?
typedoc - Documentation generator for TypeScript projects.
swagger-ui - Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
slate - Beautiful static documentation for your API
Docusaurus - Easy to maintain open source documentation websites.
elements - Build beautiful, interactive API Docs with embeddable React or Web Components, powered by OpenAPI and Markdown.
mkdocs
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.
vscode-docthis - JSDoc generator extension for Visual Studio Code.
django-rest-framework - Web APIs for Django. 🎸
API-Portal - API Portal lets you create and publish a customized site with API documentation, for free and without writing any code.
drf-yasg - Automated generation of real Swagger/OpenAPI 2.0 schemas from Django REST Framework code.
spectral - A flexible JSON/YAML linter for creating automated style guides, with baked in support for OpenAPI v3.1, v3.0, and v2.0 as well as AsyncAPI v2.x.