{"repo":"zuplo/zudoku","free":true,"listed":false,"github":"https://github.com/zuplo/zudoku","clone":"git clone https://github.com/zuplo/zudoku.git","description":"Framework for building high quality, interactive API documentation.","language":"TypeScript","stars":578,"topics":["graphql","markdown","openapi","static-site-generator","openapi-documentation","openapi3","swagger","swagger-ui"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"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 and see how good your documentation can look! ✨ Features - 🚀 Generate documentation from a single or multiple OpenAPI schema - 📄 Create MDX pages 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: 📦 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: 🧱 Getting started templates To get started with some of the features Zudoku offers you can use one of these example templa","default_branch":null,"files":null,"tree":[],"storefront":"/r/zuplo","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/zuplo/zudoku/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}