Zudoku

What Zudoku is

Zudoku is an open-source framework for creating API documentation and developer portals from OpenAPI schemas. It can draw documentation from one schema or several, and supports MDX pages for material beyond the API reference. Its interactive playground lets readers try API calls, including requests that use OpenID or OAuth2 authentication. The framework also supports API versioning and code samples. Built-in search can use tools such as Pagefind and Inkeep, and documentation can be delivered as static pages. Teams can adjust themes and colors, choose light or dark modes, add custom CSS, and extend the site with plugins they build themselves. Zudoku sites can be hosted anywhere, with deployment guidance for when a site is ready to go live. The project is MIT licensed and the maker describes it as free and open source. Listed uses include standalone documentation, API references, developer portals, and internal documentation. The quickstart requires Node.js 22.12.0 or later, or version 20.19 or later. The maker directs users to its Discord community for support and tips.

Who it suits

Zudoku suits teams building API references, developer portals, standalone documentation sites, or internal documentation from OpenAPI schemas. It is a fit for teams that want to self-host, customize the site, or add plugins and MDX pages.

Getting started

1. Open the Zudoku website
2. Install Node.js 22.12.0 or later, or version 20.19 or later
3. Use the quickstart to create a documentation site from one or more OpenAPI schemas
4. Add MDX pages, authentication, search, themes, or plugins as needed
5. Deploy the site to a hosting environment of your choice

Verdict

Pick Zudoku if you need free, open-source API documentation or a developer portal built around OpenAPI, with an interactive playground and room for customization. It is best suited to teams comfortable with the Node.js prerequisite and managing a self-hosted deployment.