redoc VS Docusaurus

Link: Redoc

OpenAPI is great, we use it in combination with redoc (https://github.com/Redocly/redoc) to have a almost 0 effort API for our product.

But man, my tokenizer is in trouble with OpenAPI and OpenAI.

Redoc: Generate API documentation

ReDoc Interactive Demo

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.

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.

Redoc: http://localhost:8080/redoc

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.

take a look

Create visibility: A good mental model of your systems, data and code is beneficial to solving for errors so create tangible mind maps or documentation for the whole team to benefit from. Miro and Docusaurus are excellent tools for this.

VitePress and Docusaurus seem decent. I think VitePress might be more suited to blogging, but I admit I haven’t actually used or tested either.

https://docusaurus.io/

https://vitepress.dev/

For efficient workflows, Commander.js offers a custom CLI, while Docusaurus powers documentation, ensuring that everything is easy to find and well-maintained.

I am aware of Docusaurus, since I have seen other documentation and some of our course material site built on it. Under the hood it uses React so I was familiar with it. But this documentation website was written in Python. Although I'm not a fan of Python, it intrigued me, since not only it is written in python, more specifically using Sphinx which utilizes reStructuredText as its markup language. There was Makefile in it as well. A lot of new things but it looked very interesting.

Docusaurus (https://docusaurus.io) is a well-regarded open-source tool for building documentation websites. It is a static-site generator that builds a single-page application leveraging the full power of React. However, it does not provide any kind of authentication out of the box. Adding authentication is crucial for securing access to your documentation.

- [Optional] List of language codes

I want to avoid JavaScript lock-in at all costs.

https://docusaurus.io/ (far from being a one-liner, still uses JavaScript)

My standard setup for writing documentation at the moment is using https://docusaurus.io with mermaid in markdown blocks. I can whip up flowcharts in seconds with http://mermaidchart.com and sometimes https://mermaid.live