{"id":28908633,"url":"https://github.com/spoo-me/docs","last_synced_at":"2025-08-03T08:05:23.046Z","repository":{"id":299064945,"uuid":"1001902905","full_name":"spoo-me/docs","owner":"spoo-me","description":"Official documentation of spoo.me URL shortener powered by mintlify","archived":false,"fork":false,"pushed_at":"2025-06-21T11:25:14.000Z","size":2173,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-21T16:48:27.186Z","etag":null,"topics":["docs","documentation","url-shortener","url-shortener-api"],"latest_commit_sha":null,"homepage":"https://docs.spoo.me","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/spoo-me.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-06-14T09:31:55.000Z","updated_at":"2025-06-21T11:24:04.000Z","dependencies_parsed_at":"2025-06-14T13:25:21.134Z","dependency_job_id":"707ce676-e9e8-4ce6-9fe6-37307eef23aa","html_url":"https://github.com/spoo-me/docs","commit_stats":null,"previous_names":["spoo-me/docs"],"tags_count":0,"template":false,"template_full_name":"mintlify/starter","purl":"pkg:github/spoo-me/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spoo-me%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spoo-me%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spoo-me%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spoo-me%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/spoo-me","download_url":"https://codeload.github.com/spoo-me/docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spoo-me%2Fdocs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268512159,"owners_count":24261887,"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-03T02:00:12.545Z","response_time":2577,"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":["docs","documentation","url-shortener","url-shortener-api"],"created_at":"2025-06-21T16:41:13.119Z","updated_at":"2025-08-03T08:05:23.034Z","avatar_url":"https://github.com/spoo-me.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Spoo.me API Documentation\n\nThis repository contains the official API documentation for **spoo.me** - a lightning-fast URL shortening service built for scale.\n\n## Overview\n\nSpoo.me provides a comprehensive API for:\n- 🔗 URL shortening with custom aliases\n- 😉 Emoji-based shortened URLs  \n- 📊 Detailed analytics and statistics\n- 📤 Data export in multiple formats\n- 🔒 Password protection and click limits\n- 🤖 Bot blocking capabilities\n\n**Base URL:** `https://spoo.me`\n\n## Documentation Features\n\n- **Complete API Reference** - All endpoints with code examples in 7+ languages\n- **Interactive Examples** - Copy-paste ready code snippets\n- **Rate Limiting Guide** - Best practices and implementation\n- **Python Library** - Official py_spoo_url documentation\n- **Discord Bot** - SpooBot integration guide\n- **Error Handling** - Comprehensive error reference\n\n## Development\n\n### Prerequisites\n\nInstall the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview documentation changes locally:\n\n```bash\nnpm i -g mintlify\n```\n\n### Local Development\n\nRun the following command at the root of the documentation directory:\n\n```bash\nmintlify dev\n```\n\nThis will start a local development server where you can preview your changes in real-time.\n\n### Project Structure\n\n```\nspoo-docs/\n├── docs.json              # Main configuration\n├── introduction.mdx       # Homepage\n├── quickstart.mdx         # Quick start guide\n├── rate-limits.mdx        # Rate limiting documentation\n├── api-reference/         # API endpoint documentation\n│   ├── shorten-url.mdx\n│   ├── emoji-url.mdx\n│   ├── url-statistics.mdx\n│   └── export-data.mdx\n└── tools/                 # Tools and integrations\n    ├── python-library.mdx\n    └── spoobot.mdx\n```\n\n## Publishing Changes\n\nChanges are automatically deployed to production when pushed to the main branch through our Mintlify integration.\n\n## Contributing\n\n1. Fork the repository\n2. Create a feature branch (`git checkout -b feature/amazing-feature`)\n3. Make your changes and test locally with `mintlify dev`\n4. Commit your changes (`git commit -m 'Add amazing feature'`)\n5. Push to the branch (`git push origin feature/amazing-feature`)\n6. Open a Pull Request\n\n## API Support\n\n- **Documentation Issues**: Open an issue in this repository\n- **API Support**: Contact [support@spoo.me](mailto:support@spoo.me)\n- **Discord Community**: Join our [Discord server](https://discord.gg/spoo-me)\n\n## Troubleshooting\n\n**Mintlify dev isn't running**\n```bash\nmintlify install  # Re-install dependencies\n```\n\n**Page loads as 404**\n- Ensure you're running in the folder containing `docs.json`\n- Check that the page exists in the navigation configuration\n\n**Build issues**\n- Verify all `.mdx` files have proper frontmatter\n- Check for syntax errors in code blocks\n- Ensure all internal links are valid\n\n---\n\nBuilt with ❤️ using [Mintlify](https://mintlify.com)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspoo-me%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspoo-me%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspoo-me%2Fdocs/lists"}