{"id":49877125,"url":"https://github.com/hsayed21/obsidian-ephemeral-overlay-plugin","last_synced_at":"2026-05-15T12:40:09.417Z","repository":{"id":339177672,"uuid":"1160394019","full_name":"hsayed21/obsidian-ephemeral-overlay-plugin","owner":"hsayed21","description":"A temporary drawing overlay plugin for Obsidian that lets you draw freehand annotations on top of your notes — like ZoomIt or Epic Pen. Perfect for presentations, teaching, or quick visual annotations.","archived":false,"fork":false,"pushed_at":"2026-02-18T14:30:16.000Z","size":65,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-02-18T15:52:17.212Z","etag":null,"topics":["annotation","epicpen","obsidian","zoomit"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"0bsd","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hsayed21.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-02-17T22:14:52.000Z","updated_at":"2026-02-18T14:30:39.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/hsayed21/obsidian-ephemeral-overlay-plugin","commit_stats":null,"previous_names":["hsayed21/obisidian-ephemeral-overlay-plugin"],"tags_count":1,"template":false,"template_full_name":"obsidianmd/obsidian-sample-plugin","purl":"pkg:github/hsayed21/obsidian-ephemeral-overlay-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hsayed21%2Fobsidian-ephemeral-overlay-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hsayed21%2Fobsidian-ephemeral-overlay-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hsayed21%2Fobsidian-ephemeral-overlay-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hsayed21%2Fobsidian-ephemeral-overlay-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hsayed21","download_url":"https://codeload.github.com/hsayed21/obsidian-ephemeral-overlay-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hsayed21%2Fobsidian-ephemeral-overlay-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33067473,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-15T11:35:32.926Z","status":"ssl_error","status_checked_at":"2026-05-15T11:35:31.362Z","response_time":103,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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":["annotation","epicpen","obsidian","zoomit"],"created_at":"2026-05-15T12:40:05.358Z","updated_at":"2026-05-15T12:40:09.412Z","avatar_url":"https://github.com/hsayed21.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ephemeral Overlay\n\nA temporary drawing overlay plugin for Obsidian that lets you draw freehand annotations on top of your notes — like ZoomIt or Epic Pen. Perfect for presentations, teaching, or quick visual annotations.\n\n**Key Feature**: All drawings are ephemeral — nothing is saved to disk. When you exit drawing mode, everything disappears.\n\n## Features\n\n- **Freehand Drawing** - Draw directly on top of your Markdown notes\n- **Multi-Input Support** - Works with mouse, touch, and Apple Pencil\n- **Color Options** - Six vibrant colors: red, yellow, blue, green, orange, pink\n- **Adjustable Pen Width** - 5 different sizes (2px to 16px)\n- **Auto-Fade Modes** - Strokes automatically disappear (1s, 3s, 5s, 7s)\n- **Mobile-Friendly** - Full iPad support with touch-optimized toolbar\n- **Pen-Only Mode** - Draw with Apple Pencil, scroll with finger simultaneously\n- **Keyboard Shortcuts** - Quick access to all tools\n- **Zero Persistence** - Drawings never saved, always temporary\n\n## Usage\n\n### Activating Drawing Mode\n\n| Method | Description |\n|--------|-------------|\n| **View Action Button** | Tap pen icon beside Edit/Read buttons (fastest!) |\n| **Ribbon Icon** | Click pencil icon in left sidebar |\n| **Command Palette** | Ctrl/Cmd + P → \"Toggle Drawing Overlay\" |\n| **Keyboard Shortcut** | Ctrl+Shift+D (desktop) |\n\n### Keyboard Shortcuts (Desktop)\n\n| Key | Action |\n|-----|--------|\n| `R/Y/B/G/O/P` | Switch color (Red/Yellow/Blue/Green/Orange/Pink) |\n| `1-5` | Pen width (2px to 16px) |\n| `F` | Cycle fade mode |\n| `E` | Clear all drawings |\n| `Esc` | Exit drawing mode |\n| `Ctrl + Scroll` | Adjust pen width |\n\n### Auto-Fade Modes\n\n| Mode | Duration |\n|------|----------|\n| Off | Never fades |\n| Quick | 1 second |\n| Medium | 3 seconds |\n| Long | 5 seconds |\n| Very Long | 7 seconds |\n\n## Installation\n\n1. Download release files (`main.js`, `manifest.json`, `styles.css`)\n2. Copy to `\u003cVault\u003e/.obsidian/plugins/ephemeral-overlay/`\n3. Reload Obsidian and enable in Settings → Community plugins\n\n### Development\n\n```bash\nnpm install\nnpm run build    # Production\nnpm run dev      # Watch mode\n```\n\n## Project Structure\n\n```\nsrc/\n  main.ts               # Plugin entry point\n  overlay.ts            # Main overlay orchestrator\n  constants.ts          # Centralized configuration\n  content-freezer.ts    # Freeze/unfreeze content elements\n  pointer-tracker.ts    # Pointer state management\n  canvas-renderer.ts    # Canvas drawing operations\n  fade-animator.ts      # Fade animation logic\n  toolbar.ts            # Mobile toolbar\n  settings.ts           # Settings UI\n  types.ts              # TypeScript types\n```\n\n## Requirements\n\n- Obsidian v0.15.0+\n- Desktop or mobile (iOS/iPadOS)\n\n## Privacy\n\n- Zero network requests\n- No telemetry\n- Drawings exist only in memory\n- All resources cleaned up on exit\n\n---\n\n**Remember**: All drawings are ephemeral. Nothing is saved! 🎨\n\n## Contributing\n\nContributions are welcome! If you encounter any issues or have suggestions for improvements, feel free to open an issue or submit a pull request.\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE.txt) - see the LICENSE file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhsayed21%2Fobsidian-ephemeral-overlay-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhsayed21%2Fobsidian-ephemeral-overlay-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhsayed21%2Fobsidian-ephemeral-overlay-plugin/lists"}