What is Zudoku?
Zudoku is an open-source API documentation framework designed to create high-quality developer experiences. It leverages OpenAPI specifications (supporting version 3.x, with 2.0 planned) to automatically generate interactive and aesthetically pleasing documentation. Built with a modern tech stack including React, Tailwind CSS, TypeScript, and Vite, Zudoku ensures a fast and responsive user interface.
The framework offers significant flexibility through features like static site generation for optimal performance and SEO, platform agnosticism allowing deployment on various cloud services (Cloudflare Pages, Vercel, Netlify, AWS Lambda), and a robust plugin system for extending functionality. It also supports MDX for combining Markdown with React components and provides theming capabilities similar to shadcn, including a built-in dark mode, for extensive customization.
Features
- OpenAPI Support: Generate documentation from OpenAPI 3.x specifications.
- Modern Tech Stack: Built with React, Tailwind CSS, TypeScript, and Vite.
- Static Site Generation: Create static sites for optimal performance and SEO.
- Platform Agnostic: Deployable on Cloudflare Pages, Vercel, Netlify, AWS Lambda, and more.
- AI Search: Integrated powerful search experience powered by Inkeep.
- Authentication Integration: Supports Auth0, Firebase, or Supabase for user authentication and API key management.
- Plugin System: Extend functionality with custom plugins.
- Interactive Playground: Test APIs directly within the documentation, including support for user API keys.
- MDX Support: Write documentation using Markdown and React components.
- Theming: Customize the look and feel using a shadcn-compatible system.
- Dark Mode: Built-in toggle for light and dark modes.
Use Cases
- Generating interactive API documentation from OpenAPI specifications.
- Building developer portals with integrated API testing.
- Creating customizable and themeable documentation sites.
- Developing fast, SEO-friendly static documentation sites.
- Providing enhanced developer experiences with AI-powered search.
