# toMarkdown-viewer
[](https://opensource.org/licenses/MIT)
[](https://www.rust-lang.org/)
[](https://nodejs.org/)
Desktop Markdown vault viewer for [toMarkdownMCP](https://github.com/carlomagnoglobal/toMarkdownMCP).
A cross-platform Tauri application that provides a beautiful, feature-rich viewer for exploring Markdown vaults with advanced features including:
- **Multi-tab interface** with keyboard shortcuts and navigation
- **Recycle bin** for safe file deletion with configurable retention
- **Clipboard operations** with multiple encoding formats (Base64, Hex, Markdown)
- **Image zoom** with pan capability (1x to 15x magnification)
- **Syntax highlighting** for code files
- **Vault indexing** with co-occurrence analysis and word graphs
- **Dark/Light/Sepia themes** with full keyboard navigation
- **Advanced file operations** including search, preview, and recent files
## Installation
### macOS
```bash
wget https://github.com/carlomagnoglobal/toMarkdown-viewer/releases/download/gui-v0.5.1/toMarkdown-viewer_0.5.1_aarch64.dmg
open toMarkdown-viewer_0.5.1_aarch64.dmg
```
### Windows
```bash
# Download .exe from releases
# Run installer
```
### Linux
```bash
# Build from source (see below)
```
## Building from Source
### Requirements
- Rust 1.88+ (via [rustup](https://rustup.rs/))
- Node.js 18+
- Tauri CLI: `npm install -g @tauri-apps/cli@next`
### Build
```bash
git clone https://github.com/carlomagnoglobal/toMarkdown-viewer.git
cd toMarkdown-viewer
# Install dependencies
npm install
# Build desktop app
npm run tauri build
```
Binary will be in `src-tauri/target/release/bundle/`.
## Development
### Run in dev mode
```bash
npm run tauri dev
```
### Run tests
```bash
cargo test -p to_markdown_gui
```
### Generate release bundle
```bash
npm run tauri build --release
```
## Version Compatibility
| 0.5.1 | ≥0.1.0 |
| 0.5.0 | ≥0.1.0 |
## Architecture
- **Backend**: Rust (Tauri 2) with SQLite vault indexing
- **Frontend**: TypeScript + HTML/CSS with vanilla JS
- **Core Dependencies**: syntect, pulldown-cmark, tauri, rusqlite
## License
MIT — See [LICENSE](./LICENSE) file.
## Contributing
Contributions welcome! Please open issues for bugs or feature requests.
## Related Projects
- [toMarkdownMCP](https://github.com/carlomagnoglobal/toMarkdownMCP) — Markdown conversion toolkit (CLI + MCP server)
- [toMarkdownMCP on crates.io](https://crates.io/crates/to_markdown_mcp)