Getting started
#App Quickstart
The recommended way to get started with Zudoku is to use the create-zudoku-app
CLI tool. This tool will scaffold a new Zudoku site for you to customize and build upon.
You will need Node.js installed to use the CLI.
- In your terminal run the following command
npm create zudoku-app@latestbash
The generator will take you through the setup steps and scaffold a minimal but fully functional documentation site for you to get started with.
- Open the newly created project in your code editor. You will find and example OpenAPI file in
/apis/openapi.yaml
. Replace this file with your own OpenAPI schema.
JSON OpenAPI Files
If your OpenAPI file is in JSON format you can create an openapi.json
. Set the file path in the zudoku.config.ts
to point to your JSON file.
- Start the development server by running
npm run devbash
You now have a fully functional Zudoku site running on your local machine. Next, commit your changes to a source repository and deploy the site to your hosting provider or CDN.