UNPKG

create-docura-app

Version:

Create a new Docura API documentation project

42 lines (29 loc) 1.45 kB
# create-docura-app A CLI tool to quickly scaffold a new Docura API documentation project. ## Usage ```bash npx create-docura-app my-api-docs cd my-api-docs npm install npm run dev ``` ## What it creates - **index.html** - Main page with RapiDoc component - **index.js** - App logic for project switching, file upload, PDF generation - **styles.css** - Styling with CSS custom properties for easy theming - **vite.config.js** - Build configuration with spec manifest generation - **public/spec/** - Directory with demo OpenAPI specs - **package.json** - Project dependencies and scripts ## Features The generated project includes: - 📁 **Multi-spec support** - Drop .yml/.yaml/.json files in `public/spec/` - 📤 **Local upload** - Upload specs directly from your machine - 📄 **PDF export** - Generate documentation PDFs - 🎨 **Easy theming** - Customize appearance using the official [RapiDoc theming API](https://rapidocweb.com/api.html) ## Customization The scaffolded project is fully customizable. You can: - Add your own OpenAPI specs by placing `.yml`, `.yaml`, or `.json` files in the `public/spec/` directory - Customize the look and feel by editing `styles.css` to adjust colors, fonts, and layout - Configure RapiDoc by adding attributes to the `<rapi-doc>` element - Extend functionality by modifying `index.js` Built on top of [RapiDoc](https://github.com/rapi-doc/RapiDoc) - a beautiful OpenAPI documentation renderer.