|
| 1 | +<div align="center"> |
| 2 | + |
| 3 | +# Open Sidenotes |
| 4 | + |
| 5 | +**A minimal, elegant side panel for quick note-taking on macOS** |
| 6 | + |
| 7 | +[](https://www.apple.com/macos/) |
| 8 | +[](https://swift.org/) |
| 9 | +[](LICENSE) |
| 10 | +[](https://github.com/mlhiter/open-sidenotes/releases) |
| 11 | + |
| 12 | +</div> |
| 13 | + |
| 14 | +--- |
| 15 | + |
| 16 | +## Features |
| 17 | + |
| 18 | +- **Edge Activation** — Move your mouse to the right edge of the screen to reveal the notes panel |
| 19 | +- **Live Markdown** — Typora-style editing with real-time rendering while preserving source syntax |
| 20 | +- **Auto Save** — Your notes are automatically saved as you type |
| 21 | +- **Lightweight** — Native SwiftUI app with minimal resource usage |
| 22 | +- **Always Available** — Works across all spaces and during full-screen apps |
| 23 | +- **Local Storage** — Notes stored as Markdown files in `~/Documents/OpenSidenotes/` |
| 24 | + |
| 25 | +## Installation |
| 26 | + |
| 27 | +### Download |
| 28 | + |
| 29 | +Download the latest release from [GitHub Releases](https://github.com/mlhiter/open-sidenotes/releases): |
| 30 | + |
| 31 | +| Chip | Download | |
| 32 | +|------|----------| |
| 33 | +| Apple Silicon (M1/M2/M3) | [open-sidenotes-arm64.dmg](https://github.com/mlhiter/open-sidenotes/releases/latest/download/open-sidenotes-arm64.dmg) | |
| 34 | +| Intel | [open-sidenotes-x86_64.dmg](https://github.com/mlhiter/open-sidenotes/releases/latest/download/open-sidenotes-x86_64.dmg) | |
| 35 | + |
| 36 | +### Build from Source |
| 37 | + |
| 38 | +```bash |
| 39 | +git clone https://github.com/mlhiter/open-sidenotes.git |
| 40 | +cd open-sidenotes |
| 41 | +xcodebuild -project open-sidenotes.xcodeproj -scheme open-sidenotes build |
| 42 | +``` |
| 43 | + |
| 44 | +## Usage |
| 45 | + |
| 46 | +1. Launch the app — it runs in the background without a dock icon |
| 47 | +2. Move your mouse to the **right edge** of the screen |
| 48 | +3. The notes panel slides in automatically |
| 49 | +4. Start writing in Markdown |
| 50 | +5. Move to the edge again to hide the panel |
| 51 | + |
| 52 | +### Keyboard Shortcuts |
| 53 | + |
| 54 | +| Shortcut | Action | |
| 55 | +|----------|--------| |
| 56 | +| `⌘ F` | Find & Replace | |
| 57 | +| `⌘ N` | New Note | |
| 58 | + |
| 59 | +### Markdown Support |
| 60 | + |
| 61 | +```markdown |
| 62 | +# Heading 1 |
| 63 | +## Heading 2 |
| 64 | + |
| 65 | +**bold** and *italic* |
| 66 | + |
| 67 | +`inline code` |
| 68 | + |
| 69 | +- List item |
| 70 | +- Another item |
| 71 | + |
| 72 | +1. Numbered |
| 73 | +2. List |
| 74 | +``` |
| 75 | + |
| 76 | +## Tech Stack |
| 77 | + |
| 78 | +- **SwiftUI** + **AppKit** for native macOS experience |
| 79 | +- **NSTextView** for rich text editing |
| 80 | +- File-based storage with YAML front matter |
| 81 | +- Zero external dependencies |
| 82 | + |
| 83 | +## Contributing |
| 84 | + |
| 85 | +Contributions are welcome! Feel free to: |
| 86 | + |
| 87 | +1. Fork the repository |
| 88 | +2. Create your feature branch (`git checkout -b feature/amazing`) |
| 89 | +3. Commit your changes (`git commit -m 'Add amazing feature'`) |
| 90 | +4. Push to the branch (`git push origin feature/amazing`) |
| 91 | +5. Open a Pull Request |
| 92 | + |
| 93 | +## License |
| 94 | + |
| 95 | +[MIT](LICENSE) © mlhiter |
| 96 | + |
| 97 | +--- |
| 98 | + |
| 99 | +<div align="center"> |
| 100 | + |
| 101 | +**[Report Bug](https://github.com/mlhiter/open-sidenotes/issues)** · **[Request Feature](https://github.com/mlhiter/open-sidenotes/issues)** |
| 102 | + |
| 103 | +</div> |
0 commit comments