{"id":51524795,"url":"https://github.com/cocoar-dev/shelf","last_synced_at":"2026-07-08T20:01:18.891Z","repository":{"id":346025904,"uuid":"1185020101","full_name":"cocoar-dev/shelf","owner":"cocoar-dev","description":null,"archived":false,"fork":false,"pushed_at":"2026-03-21T22:48:01.000Z","size":215,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"develop","last_synced_at":"2026-03-22T10:57:07.482Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cocoar-dev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"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":"NOTICE","maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-03-18T06:46:53.000Z","updated_at":"2026-03-20T11:47:11.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/cocoar-dev/shelf","commit_stats":null,"previous_names":["cocoar-dev/shelf"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/cocoar-dev/shelf","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cocoar-dev%2Fshelf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cocoar-dev%2Fshelf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cocoar-dev%2Fshelf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cocoar-dev%2Fshelf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cocoar-dev","download_url":"https://codeload.github.com/cocoar-dev/shelf/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cocoar-dev%2Fshelf/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35276781,"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-07-08T02:00:06.796Z","response_time":61,"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":[],"created_at":"2026-07-08T20:01:16.469Z","updated_at":"2026-07-08T20:01:18.885Z","avatar_url":"https://github.com/cocoar-dev.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Shelf\n\n**Shelf your Docs.** Static documentation hosting for Cocoar products.\n\nShelf is an ASP.NET Core application that serves VitePress-generated documentation sites with support for multiple products and multiple versions per product.\n\n## Features\n\n- **Multi-Product** — Host documentation for multiple products under one domain\n- **Multi-Version** — Deploy new versions without touching old ones, SemVer supported\n- **Upload API** — Deploy docs from CI/CD pipelines via HTTP (`curl` + ZIP)\n- **Base Path Rewriting** — VitePress sites built with default `base: '/'` work out of the box\n- **LLM Documentation** — Serve `llms.txt` and `llms-full.txt` for AI-friendly docs\n- **Resilient File Monitoring** — Powered by [Cocoar.FileSystem](https://github.com/cocoar-dev/Cocoar.FileSystem)\n\n## Docker Image\n\n```bash\ndocker pull ghcr.io/cocoar-dev/shelf:latest\n```\n\nAvailable tags: `latest`, `1`, `1.0`, `1.0.0`\n\n## Quick Start\n\n```yaml\n# docker-compose.yml\nservices:\n  shelf:\n    image: ghcr.io/cocoar-dev/shelf:latest\n    ports:\n      - \"80:8080\"\n    volumes:\n      - docs-data:/data/docs\n      - config-data:/data/config:ro\n    environment:\n      - Shelf__ApiKey=${SHELF_API_KEY:-}\n    restart: unless-stopped\n```\n\nDeploy via Upload API:\n\n```bash\ncurl -X POST \\\n  -H \"Authorization: Bearer $SHELF_API_KEY\" \\\n  -H \"Content-Type: application/zip\" \\\n  --data-binary @docs.zip \\\n  https://docs.example.com/api/products/configuration/versions/v5.2.0\n```\n\nOr place files directly in the volume:\n\n```\n/data/docs/configuration/v5/\n├── index.html\n├── assets/\n└── ...\n```\n\nAccess at `http://localhost/configuration/` (redirects to latest version).\n\n## Documentation\n\nFull documentation is available at **[docs.cocoar.dev/shelf](https://docs.cocoar.dev/shelf/)**.\n\n## Live Example\n\nShelf hosts its own documentation (and the docs for other Cocoar products) at **[docs.cocoar.dev](https://docs.cocoar.dev/)**.\n\n## Development\n\n```bash\n# Build\ndotnet build ./src -c Release\n\n# Test\ndotnet test ./src -c Release\n\n# Run locally\ndotnet run --project ./src/Cocoar.Shelf\n\n# Docker\ndocker compose up --build\n```\n\n## License\n\nApache-2.0 — see [LICENSE](LICENSE) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcocoar-dev%2Fshelf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcocoar-dev%2Fshelf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcocoar-dev%2Fshelf/lists"}