thoth-note
| Crates.io | thoth-note |
| lib.rs | thoth-note |
| version | 0.1.1 |
| created_at | 2025-03-08 06:11:30.284707+00 |
| updated_at | 2025-03-08 06:24:05.002729+00 |
| description | A simple note-taking app written in Rust |
| homepage | https://docs.rs/thoth-note |
| repository | https://github.com/WeiNyn/thoth-note |
| max_upload_size | |
| id | 1584125 |
| size | 523,328 |
Wei (WeiNyn)
documentation
README
Thoth 📝
A powerful terminal-based note-taking application built in Rust with full Markdown support, live preview, and syntax highlighting.
🔮 Why Thoth?
Thoth was the ancient Egyptian deity of wisdom, writing, hieroglyphs, science, and magic. As the divine scribe, he was said to have invented writing, making him the natural namesake for this powerful note-taking application. Just as Thoth was the keeper of divine records and cosmic knowledge, this application serves as your personal scribe in the digital age.
✨ Features
- Live Markdown Preview: See your formatting changes in real-time
- Syntax Highlighting: Support for multiple programming languages in code blocks
- Three-Panel Interface:
- Note List (left): Browse and manage your notes
- Editor (center): Write and edit content
- Preview (right): See rendered Markdown
- File Management: Create, edit, delete, and reorder notes
- Keyboard-Centric Navigation: Fast and efficient workflows
- Theme Support: Beautiful Catppuccin theme integration
- Full Markdown Support:
- Headers, lists, and tables
- Code blocks with syntax highlighting
- Text formatting (bold, italic, strikethrough)
- Links and images
- Blockquotes
🚀 Installation
Prerequisites
- Rust toolchain (1.70.0 or later)
Building from Source
git clone https://github.com/WeiNyn/thoth
cd thoth
cargo build --release
The binary will be available at target/release/thoth
🎮 Usage
- Launch Thoth:
./thoth - Create your first note with
Ctrl+N - Start writing in Markdown
- Toggle live preview with
Ctrl+L
⌨️ Key Bindings
| Shortcut | Action |
|---|---|
Ctrl+L |
Toggle Live Preview |
Ctrl+E |
Switch to Editor |
Ctrl+P |
Switch to Preview |
Ctrl+N |
Create new note |
Ctrl+S |
Save current note |
Ctrl+D |
Delete current note |
Ctrl+R |
Rename note |
Ctrl+Up/Down |
Navigate between notes |
Alt+Up/Down |
Reorder notes |
Ctrl+J/K |
Scroll preview |
Ctrl+Q |
Quit application |
🛠️ Dependencies
- ratatui - Terminal UI framework
- crossterm - Terminal manipulation
- edtui - Text editor widget
- pulldown-cmark - Markdown parsing
- syntect - Syntax highlighting
- catppuccin - Theme support
🗺️ Roadmap
- Search functionality
- Tags and categories
- Export to different formats
- Custom themes
- Vim keybindings
📜 License
This project is licensed under the MIT License - see the LICENSE file for details.
👤 Author
☕ Support
If you find Thoth useful, you can buy me a coffee!