Show HN: Zudoku – Open-Source Documentation Framework for APIs

14 points

2 years ago

Hey all! At Zuplo, we couldn’t find an open-source documentation solution that met our high standards for both trustworthiness and programmability, so we decided to create our own (you know, as you do).

Zudoku is a framework for building high quality, interactive API documentation. We’ve now released it as an OSS project under a MIT license: https://github.com/zuplo/zudoku)

It’s predominantly built around a highly interactive API reference powered by OpenAPI (with GraphQL support on the way), but also has MDX support, authentication options such as Auth0 and Clerk, search, static site generation, theming, and a plugin architecture that we hope will enable developers to extend Zudoku however they want/need for their use cases. All the details, and all the docs are at http://zudoku.dev

Also, if you'd like to see what your API reference would like using Zudoku, you can do that by entering a URL for an OpenAPI document or uploading the file over at https://zudoku.dev

This release is the beta version and we’d love feedback on it, either here or on GitHub.

We’re going to continue to work on it ourselves, and put out regular releases, but if anyone else wants to get involved, please play with it and let us know where you see areas for improvement.

3 comments