Quickstart

Ready to build beautiful API documentation and developer portals in minutes? Zudoku's CLI tool will have you up and running with a modern, customizable site that your developers will love.

Prerequisites

• Node.js 22.7.0+ (or 20.19+) - Download here
• A terminal or command prompt
• Your favorite code editor

Getting Started

1. Create your new Zudoku project:

   Code
    
   npm create zudoku@latest

   The CLI will walk you through setting up your project with interactive prompts. Choose from templates like API documentation, developer portals, or start from scratch.

2. Navigate to your project:

   Code
    
   cd your-project-name

3. Launch the development server:

   Code
    
   npm run dev

   🎉 That's it! Your Zudoku site is now running at http://localhost:3000. You'll see hot reloading as you make changes, so you can iterate quickly.

4. What's next?

   • Customize your theme and colors
   • Add your OpenAPI specifications
   • Set up authentication
   • Deploy your site when you're ready to go live

🚀 Pro Tips

• Use npm run build to create a production build
• Check out our examples for inspiration
• Join our Discord community for support and tips