TNote

🚀 The Markdown Note-Taking App That Actually Respects Your Privacy

Blazing Fast. Featherweight. Entirely Yours.

TNote v0.5.0 · MIT License · Tauri 2.0 + React 19 + Rust

🌐 English | 简体中文 | 日本語

---

✨ Why Developers Choose TNote

🎯 Local-First Your data lives only on your machine. No cloud. No tracking. No subscriptions.

⚡ Blazing Performance Rust-powered backend delivers sub-second startup and silky-smooth editing.

🪶 Tiny Footprint Installation package is ~5MB. That's 80% smaller than Electron apps.

---

🎨 What Makes TNote Special

Feature	Description	Status
📝 Dual-Mode Editor	Switch seamlessly between Markdown source & WYSIWYG	✅ Ready
📊 Mermaid Diagrams	Visualize ideas with flowcharts, sequence diagrams, Gantt charts	✅ Ready
🧮 KaTeX Math	Beautiful math formula rendering	✅ Ready
🎨 Shiki Highlighting	IDE-quality code syntax highlighting	✅ Ready
🌍 i18n Support	English / 中文 / 日本語 interface	✅ Ready
🔀 Git Integration	One-click Pull/Push for version control	✅ Ready
📤 Export Anywhere	Export to Word (.docx), HTML, Markdown	✅ Ready
🗂️ Multi-Notebook	Manage multiple folders simultaneously	✅ Ready
🌐 Embedded Browser	Click external links to open in-app browser with navigation controls	✅ Ready

---

🖥️ Screenshots

Light Mode	Dark Mode	Editor
		Editor Preview

---

🚀 Quick Start

Download Pre-built Binaries (Recommended)

# Windows
winget install TNote

# macOS
brew install --cask tnote

# Or download directly from Releases

📥 Download Latest Release

Platform	Installer	Size
Windows	.msi / .exe	~5MB
macOS	.dmg / .app	~6MB
Linux	.AppImage / .deb	~5MB

Build from Source

# Clone the repository
git clone https://github.com/yourusername/tnote.git
cd tnote

# Install dependencies
npm install

# Install Tauri CLI (if not already installed)
npm install -g @tauri-apps/cli

# Run in development mode
npm run tauri dev

# Build for production
npm run tauri build

Requirements:

• Node.js 18+
• Rust 1.77+
• Tauri prerequisites

---

🛠️ Technology Stack

Layer	Technology	Why We Chose It
Frontend	React 19 + TypeScript 5.9	Modern, type-safe UI development
Desktop	Tauri 2	Rust-powered, tiny binaries, native performance
Backend	Rust + Tokio	Memory-safe, blazing fast, rock solid
Editors	CodeMirror 6 + TipTap	Best-in-class editing experiences
Styling	Tailwind CSS 4	Utility-first, rapid styling
State	Zustand	Simple, powerful state management

---

📋 Roadmap

✅ Completed in v0.5.0

• Dual-mode editing (Source + WYSIWYG)
• Multi-notebook management
• File tree operations (CRUD)
• Mermaid diagram rendering
• KaTeX math formula support
• Shiki syntax highlighting
• i18n (CN/EN/JA)
• Git integration (Pull/Push)
• Export to Word (.docx) & HTML
• Drag & drop file support
• Keyboard shortcuts
• State persistence
• Embedded browser for external links

🚧 Coming Soon

• Full-text search across notebooks
• Tag system for organization
• Plugin/extension system
• Mobile companion app
• Encrypted notebooks

---

🔀 Git Integration

TNote seamlessly integrates with Git for version control:

• Auto-detection: Automatically recognizes Git repositories
• One-click sync: Pull/Push with a single button
• Smart commits: Auto-commit before push with timestamp
• Visual feedback: Multi-line toast notifications show operation results

# Your notebook is a Git repo? Perfect.
# TNote handles the rest.

---

📤 Export Options

Format	Features
Word (.docx)	Full Markdown support: headings, lists, tables, code blocks, blockquotes
HTML	Self-contained with embedded CSS styles
Markdown	Clean, portable Markdown files

Export via File → Export As... menu.

---

🤝 Contributing

We welcome contributions from the community!

# 1. Fork the repository
# 2. Create your feature branch
git checkout -b feature/amazing-feature

# 3. Commit your changes
git commit -m 'Add amazing feature'

# 4. Push to the branch
git push origin feature/amazing-feature

# 5. Open a Pull Request

Please read our Contributing Guide for details.

---

💬 Community

• 💡 Feature Requests
• 🐛 Bug Reports
• 💬 Discussions

---

📄 License

TNote is open-source software licensed under the MIT License.

MIT License

Copyright (c) 2026 TNote Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

---

⭐ Star this repo if TNote helps you!

Made with ❤️ by the TNote Team