Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zuplo/zudoku
Framework for building high quality, interactive API documentation.
https://github.com/zuplo/zudoku
graphql markdown openapi static-site-generator
Last synced: about 1 month ago
JSON representation
Framework for building high quality, interactive API documentation.
- Host: GitHub
- URL: https://github.com/zuplo/zudoku
- Owner: zuplo
- License: mit
- Created: 2024-08-16T14:09:50.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-13T09:05:16.000Z (about 1 month ago)
- Last Synced: 2024-10-13T11:52:42.922Z (about 1 month ago)
- Topics: graphql, markdown, openapi, static-site-generator
- Language: TypeScript
- Homepage: https://zudoku.dev
- Size: 2.63 MB
- Stars: 71
- Watchers: 4
- Forks: 3
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://github.com/zuplo/zudoku/license.md) [](https://www.npmjs.com/package/zudoku) [](https://www.npmjs.com/package/create-zudoku-app) [](https://zuplo.com)
# Zudoku
API documentation should always be free.
Installation · Docs · Examples · Contributing · Motivation
## Introduction
**Zudoku** (pronounced "zoo-doh-koo") is an open-source, highly customizable API documentation framework for building quality developer experiences around OpenAPI and, soon, GraphQL documents.
Because great API documentation frameworks should be:
🌍 Free & Open Source
✅ OpenAPI powered
🔩 Extensible with Plugins
⚡ Easy to setup & blazing fast to work with
🔧 Easy to maintain
## 🤩 Try it, right now!
You can test Zudoku with your own OpenAPI document at [zudoku.dev](https://zudoku.dev?utm_source=github&utm_medium=web&utm_content=link&ref=github) and see how good your documentation can look!
## ✨ Features
- 🚀 Generate documentation from a single or multiple [OpenAPI](https://swagger.io/specification/) schema
- 📄 Create [MDX pages](https://mdxjs.com/) for anything you want to document
- 🔐 Integrate your users with authentication via OpenID or OAuth2
- 🧪 Let users test their API calls using the Integrated Playground (includes authentication!)
- 🌑 Dark mode (of course!)
Zudoku is quick to implement, easy to configure and is highly composable with sensible defaults.
## ⚙️ Installation
You can use the CLI to generate a new project or use it standalone via CDN as a React component.
### ⚡️ Quick start
Fire up your new API docs using the command line generator:
```
npm create zudoku-app@latest
```
### 📦 Standalone via CDN
Add the package and styles to your `` and pass the URL for your API schema to the `data-api-url` property, as shown here:
```html
Zudoku Demo
```
### 🧱 Getting started templates
To get started with some of the features Zudoku offers you can use one of these [example templates](https://github.com/zuplo/zudoku/tree/main/examples):
| Template | What it does |
| --------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| [many-apis](https://github.com/zuplo/zudoku/tree/main/examples/many-apis) | Using more than one OpenAPI document with Zudoku |
| [with-auth0](https://github.com/zuplo/zudoku/tree/main/examples/with-auth0) | Authenticate users in docs with the Auth0 plugin |
| [with-config](https://github.com/zuplo/zudoku/tree/main/examples/with-config) | Barebones config, ready for you to setup how you like |
| [with-vite-config](https://github.com/zuplo/zudoku/tree/main/examples/with-vite-config) | Use Zudoku with your Vite config (Advanced) |
## 🎓 Examples
- [Rick & Morty API](https://zudoku.dev/demo?api-url=https://rickandmorty.zuplo.io/openapi.json)
- [Pet Store API](https://zudoku.dev/demo?api-url=https://zudoku.dev/petstore.oas.json)
- [Zuplo API Documentation](https://docs-zudoku.pages.dev/)
### Zudoku use cases
Zudoku is a flexible and highly customizable framework that can be used to create many things, including:
- Standalone documentation websites
- OpenAPI powered API references
- A developer portal with documentation, fully functional API reference for testing and authentication support for your user accounts.
- Internal documentation
## 🔧 Contributing & Community
For details on how to contribute to Zudoku, see the [contributing guide](CONTRIBUTING.md).
## Changelog
Details of the latest updates to Zudoku can be found in the [changelog](CHANGELOG.md).
## 🎯 Motivation
At Zuplo, we couldn’t find an open-source solution that met our high standards for both trustworthiness and programmability, so we decided to create our own. And since no one chooses Zuplo solely because of our documentation, we felt great about open-sourcing this tool and making it easy for anyone to self-host.
We hope that if you use it, you’ll think fondly of Zuplo, and one day, when you’re looking for a gateway or API management product, you’ll consider us as a vendor to evaluate.
Zudoku will always be open-source. It will always be free.
## License
Zudoku is licensed under MIT. See the full [license](LICENSE.md).
