{"id":31424876,"url":"https://github.com/rafactx/api-docs-starter","last_synced_at":"2026-04-20T19:03:14.014Z","repository":{"id":315188638,"uuid":"1058252057","full_name":"rafactx/api-docs-starter","owner":"rafactx","description":"Modern API documentation starter with VitePress, Vue 3, and Scalar. Multi-language, interactive \u0026 production-ready.","archived":false,"fork":false,"pushed_at":"2025-09-17T07:05:56.000Z","size":685,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-17T08:20:51.624Z","etag":null,"topics":["api","documentation","openapi","rest","scalar","starter","swagger","template","typescript","vercel","vitepress","vue3"],"latest_commit_sha":null,"homepage":"https://api-docs-starter-rafactx.vercel.app/","language":"TypeScript","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/rafactx.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":"rafactx","thanks_dev":null,"custom":null}},"created_at":"2025-09-16T20:46:27.000Z","updated_at":"2025-09-17T07:05:59.000Z","dependencies_parsed_at":"2025-09-17T08:22:27.136Z","dependency_job_id":"89dc2de8-a0d3-4470-8917-652eeaf5b1ad","html_url":"https://github.com/rafactx/api-docs-starter","commit_stats":null,"previous_names":["rafactx/api-docs-starter"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/rafactx/api-docs-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rafactx%2Fapi-docs-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rafactx%2Fapi-docs-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rafactx%2Fapi-docs-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rafactx%2Fapi-docs-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rafactx","download_url":"https://codeload.github.com/rafactx/api-docs-starter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rafactx%2Fapi-docs-starter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":277627616,"owners_count":25849914,"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-09-30T02:00:09.208Z","response_time":75,"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","openapi","rest","scalar","starter","swagger","template","typescript","vercel","vitepress","vue3"],"created_at":"2025-09-30T04:07:45.682Z","updated_at":"2025-09-30T04:07:51.004Z","avatar_url":"https://github.com/rafactx.png","language":"TypeScript","funding_links":["https://buymeacoffee.com/rafactx"],"categories":[],"sub_categories":[],"readme":"# API Documentation Starter\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Node.js Version](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen)](https://nodejs.org/)\n[![Vue.js](https://img.shields.io/badge/Vue.js-3.x-green.svg)](https://vuejs.org/)\n[![VitePress](https://img.shields.io/badge/VitePress-1.0-blue.svg)](https://vitepress.dev/)\n[![Deployed with Vercel](https://img.shields.io/badge/Deployed%20with-Vercel-black?logo=vercel\u0026logoColor=white)](https://api-docs-starter-rafactx.vercel.app/)\n\nA modern, professional API documentation template built with VitePress, Vue 3, and Scalar. This starter provides everything you need to create beautiful, interactive API documentation with multi-language support and best-in-class developer experience.\n\n\u003e **📖 Also available in Portuguese**: [README.pt-br.md](README.pt-br.md)\n\n## Quick Start\n\nGet your API documentation up and running in minutes.\n\nLatest release: [v0.1.0](https://github.com/rafactx/api-docs-starter/releases/tag/v0.1.0)\n\n### Prerequisites\n\n- **Node.js** (\u003e=18.0.0)\n- **pnpm** (\u003e=8.15.5) - recommended for optimal performance\n\n### Installation\n\n```bash\n# Clone the repository\ngit clone https://github.com/rafactx/api-docs-starter.git\ncd api-docs-starter\n\n# Install dependencies\npnpm install\n```\n\n### Development\n\nStart the development server with hot-reloading:\n\n```bash\npnpm run dev\n```\n\nVisit [`http://localhost:5173`](http://localhost:5173) to see your documentation.\n\n### Production Build\n\nGenerate a static version for deployment:\n\n```bash\npnpm run build\n```\n\nPreview the production build locally:\n\n```bash\npnpm run preview\n```\n\n## Project Structure\n\n```plaintext\n.\n├── docs/                              # VitePress Documentation\n│   ├── .vitepress/                    # VitePress configuration \u0026 theme\n│   │   ├── components/                # Custom Vue components\n│   │   │   ├── ApiCard.vue           # API feature cards\n│   │   │   ├── HeroSection.vue       # Landing page hero\n│   │   │   ├── ScalarApi.vue         # Interactive API reference\n│   │   │   └── SpotlightBackground.vue # Animated background\n│   │   ├── theme/                     # Global styles and theme files\n│   │   │   ├── fonts.css            # Font loading and configuration\n│   │   │   ├── style.css            # Global styles\n│   │   │   ├── sidebar.css          # Sidebar customization\n│   │   │   ├── api-docs-responsive.css # Mobile optimizations\n│   │   │   └── theme.css            # Color palette and variables\n│   │   ├── config.ts                 # Main VitePress configuration\n│   │   └── index.ts                  # Theme entry point\n│   ├── public/                       # Static assets\n│   │   ├── openapi.json             # OpenAPI specification (English)\n│   │   ├── openapi-pt-br.json        # OpenAPI specification (Portuguese)\n│   │   ├── openapi-es.json          # OpenAPI specification (Spanish)\n│   │   ├── openapi-fr.json          # OpenAPI specification (French)\n│   │   ├── logo-light.svg           # Light theme logo\n│   │   └── logo-dark.svg            # Dark theme logo\n│   ├── en/                           # English content\n│   ├── es/                           # Spanish content\n│   ├── fr/                           # French content\n│   ├── pt/                           # Portuguese content\n│   └── index.md                      # Language redirection\n├── .github/                          # GitHub templates and workflows\n├── .gitignore                        # Git exclusions\n├── LICENSE                           # MIT License\n├── CHANGELOG.md                     # Version history and changes\n├── CODE_OF_CONDUCT.md               # Community guidelines\n├── CONTRIBUTING.md                  # Contribution guidelines\n├── SECURITY.md                      # Security policy\n├── package.json                      # Dependencies and scripts\n├── tsconfig.json                     # TypeScript configuration\n└── vite.config.ts                    # Vite build configuration\n```\n\n## Key Features\n\n### Modern Design\n\n- **Apple-inspired UI** with clean, professional aesthetics\n- **Dark/Light theme** with seamless switching\n- **Responsive design** optimized for all devices\n- **Smooth animations** and micro-interactions\n\n### Multi-language Support\n\n- **4 languages**: English, Portuguese, Spanish, French\n- **Automatic language detection** based on browser preferences\n- **Language switcher** with flag indicators\n- **Localized OpenAPI specifications** for each language\n\n### Interactive API Reference\n\n- **Scalar integration** for interactive API testing\n- **Live endpoint testing** directly in documentation\n- **Code examples** in multiple programming languages\n- **Comprehensive schema documentation**\n\n### Performance Optimized\n\n- **Code splitting** for optimal loading\n- **Lazy loading** for components and images\n- **Optimized builds** with tree shaking\n- **Progressive Web App** ready\n- **Vercel Analytics** for visitor tracking and insights\n- **Speed Insights** for performance monitoring\n\n### Developer Experience\n\n- **TypeScript** for type safety\n- **Hot module replacement** for rapid development\n- **ESLint + Prettier** for code quality\n- **Comprehensive tooling** out of the box\n\n## Customization Guide\n\n### Branding and Colors\n\nUpdate the theme colors in `docs/.vitepress/theme/theme.css`:\n\n```css\n:root {\n  /* Update these variables with your brand colors */\n  --vp-c-brand: #3b82f6;\n  --vp-c-brand-light: #60a5fa;\n  --vp-c-brand-dark: #2563eb;\n}\n```\n\n### Logo and Assets\n\nReplace the default logos in `docs/public/`:\n\n- `logo-light.svg` - Light theme logo\n- `logo-dark.svg` - Dark theme logo\n\n### OpenAPI Specification\n\nCustomize the API specification in `docs/public/openapi.json`:\n\n1. Update the `info` section with your API details\n2. Add your API endpoints and schemas\n3. Translate for other languages if needed\n\n### Content Organization\n\nAdd your documentation pages in the respective language folders:\n\n- `docs/en/` - English documentation\n- `docs/pt/` - Portuguese documentation\n- `docs/es/` - Spanish documentation\n- `docs/fr/` - French documentation\n\n### Navigation\n\nUpdate the sidebar and navigation in `docs/.vitepress/config.ts`:\n\n```typescript\nsidebar: [\n  {\n    text: 'API Guide',\n    items: [\n      { text: '🚀 Introduction', link: '/en/intro' },\n      { text: '🔐 Authentication', link: '/en/authentication' },\n      // Add your pages here\n    ]\n  }\n]\n```\n\n## Deployment\n\n### Static Hosting\n\nThe build output is static and can be deployed to any static hosting service:\n\n```bash\n# Build for production\npnpm run build\n\n# The static files are in docs/.vitepress/dist\n```\n\n### Vercel (Recommended)\n\n1. Connect your repository to Vercel\n2. Set the build command to `pnpm run build`\n3. Set the output directory to `docs/.vitepress/dist`\n\n**Analytics \u0026 Monitoring**: This template includes Vercel Analytics and Speed Insights out of the box. Once deployed, you'll automatically start collecting visitor data and performance metrics in your Vercel dashboard.\n\n### Other Platforms\n\n- **Netlify**: Build command `pnpm run build`, Publish directory `docs/.vitepress/dist`\n- **GitHub Pages**: Use the `gh-pages` branch\n- **AWS S3**: Upload the `docs/.vitepress/dist` folder\n\n## Contributing\n\nWe welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details.\n\n### Development Workflow\n\n1. Fork the repository\n2. Create a feature branch: `git checkout -b feature/amazing-feature`\n3. Make your changes\n4. Run quality checks: `pnpm run lint \u0026\u0026 pnpm run format`\n5. Commit your changes: `git commit -m 'feat: add amazing feature'`\n6. Push to the branch: `git push origin feature/amazing-feature`\n7. Open a Pull Request\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\n- [VitePress](https://vitepress.dev/) - Static Site Generator\n- [Vue.js](https://vuejs.org/) - Progressive JavaScript Framework\n- [Scalar](https://scalar.com/) - Interactive API Reference\n- [TailwindCSS](https://tailwindcss.com/) - Utility-First CSS Framework\n\n## Support\n\n- 📧 **Email**: [rafactx@icloud.com](mailto:rafactx@icloud.com)\n- 🐛 **Issues**: [GitHub Issues](https://github.com/rafactx/api-docs-starter/issues)\n- 💬 **Discussions**: [GitHub Discussions](https://github.com/rafactx/api-docs-starter/discussions)\n\n---\n\nMade with care by [rafactx](https://github.com/rafactx) and contributors\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frafactx%2Fapi-docs-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frafactx%2Fapi-docs-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frafactx%2Fapi-docs-starter/lists"}