{"id":34587180,"url":"https://github.com/replane-dev/replane-website","last_synced_at":"2026-06-01T09:31:35.154Z","repository":{"id":324513497,"uuid":"1097433619","full_name":"replane-dev/replane-website","owner":"replane-dev","description":"Replane website","archived":false,"fork":false,"pushed_at":"2026-03-31T08:05:49.000Z","size":5284,"stargazers_count":0,"open_issues_count":19,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-31T10:10:37.987Z","etag":null,"topics":["ab-testing","dynamic-config","dynamic-log-level","environment-variables","feature-flags","kill-switches","operational-tuning","remote-config"],"latest_commit_sha":null,"homepage":"https://replane.dev","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/replane-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-16T06:54:02.000Z","updated_at":"2026-03-31T08:05:54.000Z","dependencies_parsed_at":null,"dependency_job_id":"203218e7-ef4e-40a5-86de-61956fef2359","html_url":"https://github.com/replane-dev/replane-website","commit_stats":null,"previous_names":["replane-dev/replane-website"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/replane-dev/replane-website","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/replane-dev%2Freplane-website","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/replane-dev%2Freplane-website/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/replane-dev%2Freplane-website/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/replane-dev%2Freplane-website/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/replane-dev","download_url":"https://codeload.github.com/replane-dev/replane-website/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/replane-dev%2Freplane-website/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33769490,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-01T02:00:06.963Z","response_time":115,"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":["ab-testing","dynamic-config","dynamic-log-level","environment-variables","feature-flags","kill-switches","operational-tuning","remote-config"],"created_at":"2025-12-24T10:34:23.267Z","updated_at":"2026-06-01T09:31:35.149Z","avatar_url":"https://github.com/replane-dev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Replane Documentation Website\n\nOfficial documentation website for [Replane](https://github.com/replane-dev/replane) - dynamic configuration for apps and services.\n\n[![Website](https://img.shields.io/badge/website-replane.dev-blue)](https://replane.dev)\n[![License](https://img.shields.io/github/license/replane-dev/replane-website)](https://github.com/replane-dev/replane-website/blob/main/LICENSE)\n[![Community](https://img.shields.io/badge/discussions-join-blue?logo=github)](https://github.com/orgs/replane-dev/discussions)\n\n## Tech Stack\n\n- **Docusaurus V3** - Documentation framework\n- **TailwindCSS V4** - Styling\n- **Shadcn/UI** - Component library\n- **OpenAPI Docs** - Auto-generated API reference from OpenAPI spec\n- **Local Search** - Full-text search powered by `@easyops-cn/docusaurus-search-local`\n\n## Local Development\n\n### Prerequisites\n\n- Node.js 18+\n- npm, yarn, or pnpm\n\n### Setup\n\n1. Clone the repository:\n\n```bash\ngit clone https://github.com/replane-dev/replane-website.git\ncd replane-website\n```\n\n2. Install dependencies:\n\n```bash\nnpm install\n# or\nyarn install\n# or\npnpm install\n```\n\n3. Start the development server:\n\n```bash\nnpm start\n```\n\nThe site will open at `http://localhost:8080`.\n\n### Building\n\nGenerate a production build:\n\n```bash\nnpm run build\n```\n\nServe the production build locally:\n\n```bash\nnpm run serve\n```\n\n## Project Structure\n\n```\nreplane-website/\n├── api-swagger/          # OpenAPI specification files\n│   └── replane.yaml      # Replane API spec\n├── blog/                 # Blog posts\n├── docs/                 # Documentation content\n│   ├── getting-started/  # Quickstart and installation guides\n│   ├── concepts/         # Core concepts and architecture\n│   ├── self-hosting/     # Deployment guides\n│   ├── guides/           # Use case guides\n│   ├── sdk/              # SDK documentation\n│   └── api/              # Generated API reference\n├── src/\n│   ├── components/       # React components\n│   │   ├── ui/           # Shadcn/UI components\n│   │   └── Homepage/     # Homepage components\n│   ├── css/              # Styles\n│   ├── pages/            # Custom pages\n│   ├── plugins/          # Docusaurus plugins\n│   └── theme/            # Theme customizations\n├── static/               # Static assets\n└── docusaurus.config.js  # Docusaurus configuration\n```\n\n## Generating API Documentation\n\nThe API reference is automatically generated from the OpenAPI specification:\n\n```bash\n# Generate API docs\nnpm run gen-api-docs\n\n# Clean generated API docs\nnpm run clean-api-docs\n```\n\nThe OpenAPI spec is located at `api-swagger/replane.yaml`. After updating it, regenerate the docs.\n\n## Writing Documentation\n\n### Adding New Docs\n\n1. Create a new Markdown file in the appropriate `docs/` subdirectory\n2. Add frontmatter with metadata:\n\n```markdown\n---\nsidebar_position: 1\ntitle: Your Page Title\n---\n\n# Your Page Title\n\nYour content here...\n```\n\n3. The page will automatically appear in the sidebar based on the directory structure\n\n### Linking Between Pages\n\nUse absolute paths for links to ensure they work correctly:\n\n```markdown\n[Link text](/docs/path/to/page)\n```\n\nAvoid relative links like `./page` or `../other/page` as they may break with `trailingSlash: false`.\n\n### Adding Images\n\nPlace images in `static/img/` and reference them:\n\n```markdown\n![Alt text](/img/your-image.png)\n```\n\n## Configuration\n\n### Site Config\n\nMain configuration is in `docusaurus.config.js`:\n\n- Site metadata (title, tagline, URL)\n- Theme configuration\n- Plugin settings\n- Navigation and footer links\n\n### Styling\n\n- TailwindCSS configuration is in `src/css/custom.css` (v4)\n- Custom CSS variables and overrides are also in `custom.css`\n- Shadcn/UI components are in `src/components/ui/`\n\n### Search\n\nThe local search is configured to:\n\n- Index all pages including docs and blog\n- Support keyboard shortcuts (Cmd/Ctrl + K)\n- Provide search suggestions\n- Highlight search terms\n\n## Deployment\n\nThe site is configured for deployment to static hosting platforms:\n\n### Vercel (Recommended)\n\n1. Push to GitHub\n2. Import the repository in Vercel\n3. Vercel will auto-detect Docusaurus and deploy\n\n### Manual Deploy\n\n```bash\nnpm run build\n# Upload the 'build' directory to your hosting provider\n```\n\n## Contributing\n\nContributions to the documentation are welcome!\n\n1. Fork the repository\n2. Create a feature branch: `git checkout -b docs/your-improvement`\n3. Make your changes\n4. Test locally: `npm start`\n5. Build to check for errors: `npm run build`\n6. Submit a pull request\n\n### Writing Guidelines\n\n- Use clear, concise language\n- Include code examples where appropriate\n- Add screenshots for UI walkthroughs\n- Test all links and code snippets\n- Follow the existing structure and formatting\n\n## Contributing\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and contribution guidelines.\n\n## Community\n\nHave questions or want to discuss Replane? Join the conversation in [GitHub Discussions](https://github.com/orgs/replane-dev/discussions).\n\n## Resources\n\n- [Replane Main Repository](https://github.com/replane-dev/replane)\n- [Docusaurus Documentation](https://docusaurus.io/)\n- [TailwindCSS Documentation](https://tailwindcss.com/)\n- [Shadcn/UI Documentation](https://ui.shadcn.com/)\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freplane-dev%2Freplane-website","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freplane-dev%2Freplane-website","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freplane-dev%2Freplane-website/lists"}