{"id":30641858,"url":"https://github.com/minuth/docura","last_synced_at":"2026-05-18T15:02:22.958Z","repository":{"id":311276656,"uuid":"1042180374","full_name":"minuth/docura","owner":"minuth","description":"A modern, customizable documentation viewer for OpenAPI/Swagger","archived":false,"fork":false,"pushed_at":"2025-08-23T18:48:04.000Z","size":1434,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-23T19:39:31.987Z","etag":null,"topics":["api-documentation","api-tools","api-viewer","documentation","openapi","openapi-specification","rapidoc","rapipdf","swagger","swagger-ui"],"latest_commit_sha":null,"homepage":"https://docura-playground.netlify.app/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/minuth.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-08-21T15:53:36.000Z","updated_at":"2025-08-23T19:18:27.000Z","dependencies_parsed_at":"2025-08-23T19:39:33.944Z","dependency_job_id":"888b58e5-1bc2-4989-9de4-7b3631f6c4a5","html_url":"https://github.com/minuth/docura","commit_stats":null,"previous_names":["minuth/docura"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/minuth/docura","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minuth%2Fdocura","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minuth%2Fdocura/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minuth%2Fdocura/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minuth%2Fdocura/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/minuth","download_url":"https://codeload.github.com/minuth/docura/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minuth%2Fdocura/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272930012,"owners_count":25017058,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-31T02:00:09.071Z","response_time":79,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-documentation","api-tools","api-viewer","documentation","openapi","openapi-specification","rapidoc","rapipdf","swagger","swagger-ui"],"created_at":"2025-08-31T02:01:47.415Z","updated_at":"2026-05-18T15:02:22.874Z","avatar_url":"https://github.com/minuth.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docura\n\nDocura is a lightweight API documentation platform built on top of the excellent RapiDoc project. Drop your OpenAPI specs (YAML or JSON) into a folder and get a ready-to-use docs site with search, Try-It, and PDF export.\n\nThis project wraps RapiDoc and RapiPdf for a simple, zero-backend workflow. You still have full access to RapiDoc’s attributes and theming when you need them.\n\n## Usage\n\n```bash\nnpx create-docura-app my-api-docs\ncd my-api-docs\nnpm install\nnpm run dev\n```\n\nNotes\n- Requires Node.js 14+ (18+ recommended).\n- A spec manifest is generated automatically at dev and build.\n\n## What it creates\n\n- **index.html** - Main page with RapiDoc component\n- **index.js** - App logic for project switching, file upload, PDF generation\n- **styles.css** - Styling with CSS custom properties for easy theming\n- **vite.config.js** - Build configuration with spec manifest generation\n- **public/spec/** - Directory with demo OpenAPI specs\n- **package.json** - Project dependencies and scripts\n - **public/spec-manifest.json** - Auto-generated map of available specs (don’t edit)\n\n## Features\n\nThe generated project includes:\n\n- 📁 **Multi-spec support** - Drop .yml/.yaml/.json files in `public/spec/`\n- 📤 **Local upload** - Upload specs directly from your machine\n- 📄 **PDF export** - Generate documentation PDFs\n- 🎨 **Easy theming** - Customize appearance using the official [RapiDoc theming API](https://rapidocweb.com/api.html)\n\n## Add your specs\n\n- Place `.yml`, `.yaml`, or `.json` files in `public/spec/`.\n- The Vite plugin writes `public/spec-manifest.json` that powers the Project dropdown.\n\nYou can also click “Upload Local Spec” to load a file without placing it in the repo.\n\n## Customization\n\nThe scaffolded project is fully customizable. You can:\n\n- Add your own OpenAPI specs by placing `.yml`, `.yaml`, or `.json` files in the `public/spec/` directory\n- Customize the look and feel by editing `styles.css` to adjust colors, fonts, and layout\n- Configure RapiDoc by adding attributes to the `\u003crapi-doc\u003e` element\n- Extend functionality by modifying `index.js`\n\n\n## Build and deploy\n\nDevelopment\n```bash\nnpm run dev\n```\n\nProduction build\n```bash\nnpm run build\nnpm run preview # optional local preview\n```\n\nThe output is static (in `dist/`) and can be hosted on any static host (Netlify, Vercel, GitHub Pages, S3, etc.).\n\n## Credits\n\nDocura is built on top of RapiDoc and RapiPdf. Big thanks to the RapiDoc team and contributors.\n\n- RapiDoc: https://github.com/rapi-doc/RapiDoc\n- RapiPdf: https://github.com/mrin9/RapiPdf\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminuth%2Fdocura","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fminuth%2Fdocura","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminuth%2Fdocura/lists"}