{"id":49948037,"url":"https://github.com/jan-nikolov/astro-annotate","last_synced_at":"2026-05-17T17:07:18.379Z","repository":{"id":339593633,"uuid":"1162612647","full_name":"jan-nikolov/astro-annotate","owner":"jan-nikolov","description":"Visual annotation overlay for Astro staging sites. Annotations stored as structured JSON, readable by developers and LLMs.","archived":false,"fork":false,"pushed_at":"2026-03-20T12:56:19.000Z","size":2449,"stargazers_count":3,"open_issues_count":15,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-21T05:24:35.867Z","etag":null,"topics":["annotations","astro","astro-integration","developer-tools","devtools","feedback","llm","shadow-dom","staging","typescript"],"latest_commit_sha":null,"homepage":"https://github.com/jan-nikolov/astro-annotate#readme","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/jan-nikolov.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2026-02-20T13:34:43.000Z","updated_at":"2026-03-20T12:56:16.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/jan-nikolov/astro-annotate","commit_stats":null,"previous_names":["jan-nikolov/astro-annotate"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/jan-nikolov/astro-annotate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jan-nikolov%2Fastro-annotate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jan-nikolov%2Fastro-annotate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jan-nikolov%2Fastro-annotate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jan-nikolov%2Fastro-annotate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jan-nikolov","download_url":"https://codeload.github.com/jan-nikolov/astro-annotate/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jan-nikolov%2Fastro-annotate/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33147340,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-17T09:28:26.183Z","status":"ssl_error","status_checked_at":"2026-05-17T09:27:52.702Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["annotations","astro","astro-integration","developer-tools","devtools","feedback","llm","shadow-dom","staging","typescript"],"created_at":"2026-05-17T17:07:14.445Z","updated_at":"2026-05-17T17:07:18.372Z","avatar_url":"https://github.com/jan-nikolov.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# astro-annotate\n\n[![npm version](https://img.shields.io/npm/v/astro-annotate)](https://www.npmjs.com/package/astro-annotate)\n[![npm downloads](https://img.shields.io/npm/dm/astro-annotate)](https://www.npmjs.com/package/astro-annotate)\n[![License: MIT](https://img.shields.io/npm/l/astro-annotate)](./LICENSE)\n[![Built for Astro](https://img.shields.io/badge/astro-v4%20%7C%20v5%20%7C%20v6-FF5D01?logo=astro)](https://astro.build)\n\nVisual annotation overlay for Astro staging sites. Clients and stakeholders annotate HTML elements directly in the browser. Annotations are stored as structured JSON, readable by developers and LLMs.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"docs/assets/demo.gif\" alt=\"astro-annotate demo: hover to highlight, click to annotate, view in panel\" width=\"720\" /\u003e\n\u003c/p\u003e\n\n\u003e **Status:** Phase 1 (MVP) \u0026mdash; local dev mode. Works with `astro dev`.\n\n## Why astro-annotate?\n\n- **Built for Astro** \u0026mdash; `npx astro add`, Dev Toolbar icon, View Transitions support\n- **Zero dependencies** \u0026mdash; vanilla TypeScript client, ~15KB gzipped\n- **LLM-native** \u0026mdash; annotations saved as `annotations.json` with CSS selectors, feed directly to Claude Code or Cursor\n- **No SaaS, no account** \u0026mdash; everything stays in your repo, no third-party service\n- **Shadow DOM isolated** \u0026mdash; overlay UI never touches your site's styles\n\n## Quick Start\n\n```bash\nnpx astro add astro-annotate\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eManual installation\u003c/summary\u003e\n\n```bash\nnpm install astro-annotate\n```\n\n```js\n// astro.config.mjs\nimport { defineConfig } from 'astro/config';\nimport annotate from 'astro-annotate';\n\nexport default defineConfig({\n  integrations: [annotate()],\n});\n```\n\n\u003c/details\u003e\n\n## Features\n\n- **Element-based annotations** \u0026mdash; hover to highlight, click to annotate any HTML element\n- **Figma-style pins** \u0026mdash; small teardrops that point toward annotated elements with directional tilt\n- **Draggable panel** \u0026mdash; freely movable annotations panel with resize handle and snap-to-side docking\n- **CSS selector tracking** \u0026mdash; annotations reference elements by robust CSS selectors (IDs, data-testid, tag+class)\n- **JSON storage** \u0026mdash; annotations saved as `annotations.json`, directly readable by developers and LLMs\n- **Astro Dev Toolbar** \u0026mdash; native toolbar icon with notification badge for open annotations\n- **Device detection** \u0026mdash; automatically tags annotations as mobile/tablet/desktop\n\n## Keyboard Shortcuts\n\n| Shortcut | Action |\n|----------|--------|\n| `Alt + C` | Toggle annotation mode |\n| `Alt + L` | Toggle annotations panel |\n| `Escape` | Close topmost UI (form \u0026rarr; detail \u0026rarr; panel \u0026rarr; exit mode) |\n| `Ctrl + Enter` | Submit annotation |\n\n## Reading Annotations\n\nThe `annotations.json` file is structured for both humans and machines:\n\n```json\n{\n  \"version\": \"1.0\",\n  \"annotations\": [\n    {\n      \"id\": \"abc123\",\n      \"page\": \"/\",\n      \"selector\": \"h1.hero-title\",\n      \"text\": \"Make this headline shorter\",\n      \"author\": \"Client Name\",\n      \"status\": \"open\",\n      \"device\": \"desktop\",\n      \"viewport\": { \"width\": 1440, \"height\": 900 }\n    }\n  ]\n}\n```\n\n## Configuration\n\n| Option | Default | Description |\n|--------|---------|-------------|\n| `enabled` | `true` in dev | Enable the annotation overlay |\n| `storage` | `'local'` | Storage backend |\n| `annotationsPath` | `'./annotations.json'` | Path to the annotations file |\n\n```js\nannotate({\n  enabled: true,\n  storage: 'local',\n  annotationsPath: './annotations.json',\n})\n```\n\n## Roadmap\n\n- **Phase 2:** Deployed mode on Cloudflare Pages with password auth\n- **Phase 3:** Screenshots, CLI export, mobile UX, docs\n\n## Contributing\n\nContributions welcome! See [CONTRIBUTING.md](./CONTRIBUTING.md) for setup instructions.\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjan-nikolov%2Fastro-annotate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjan-nikolov%2Fastro-annotate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjan-nikolov%2Fastro-annotate/lists"}