redoc VS Outline

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

Redoc is an open source tool to generate API reference documentation websites from OpenAPI definitions.

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 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.

Outline is another open-source tool I’ve been using lately for note-taking and knowledgebase purposes. Previously, my app of choice for this was Bear.app. It worked out well for markdown notes, but I needed something more like a wiki to organize content. I discovered Outline in late 2022 and found it to be a snappy experience and just what I needed: nestable collections, markdown, and a decent search experience. Outline delivers that and more. It also offers real-time collaborative editing like Google Docs and public shares for either a single page or for all nested pages of a share.

Just be careful that while it is self-hostable and the source is available, it is not open source [1,2]. If this is something important for your consideration before using it.

[1] https://github.com/outline/outline/blob/main/LICENSE

[2] https://fossa.com/blog/business-source-license-requirements-...

Try outline or trillium

Outline is a simple, fast and sweet Wiki software, I recommend, this is an open source projet, the community is reactive and even the SaaS platform pricing is really honest !

Have a look at https://www.getoutline.com/

I'm really impressed by the product. Seems to be a good Confluence alternative.

- Outline