Flare

Fast, themeable markdown viewer. Opens .md files in a native window with syntax highlighting, a table of contents sidebar, and live reload.

Built with Tauri v2 and Rust.

Install

Installer (Windows)

Download the latest .msi or .exe installer from Releases.

npm

npm install -g github:GBX-Group/flare

Requires read access to the repo. Downloads a pre-built binary automatically.

Build from source

Requires Rust and the Tauri prerequisites.

git clone https://github.com/GBX-Group/flare.git
cd flare/src-tauri
cargo build --release

Binary output: src-tauri/target/release/flare.exe

Usage

flare <FILE> [--theme <THEME>]

flare README.md
flare docs/SPEC.md --theme github-light

Themes

Three built-in themes, switchable from the dropdown in the sidebar:

| Theme | Description | |-------|-------------| | github-dark | GitHub dark mode (default) | | github-light | GitHub light mode | | tokyo-night | Tokyo Night color scheme |

Theme selection persists across sessions via localStorage.

Features

• Native window - lightweight Tauri/WebView2 app, not a browser tab
• Table of contents - auto-generated sidebar from headings
• Live reload - file watcher updates the view on save
• Theme switching - three themes, switchable at runtime
• Syntax highlighting - fenced code blocks with language classes
• Small binary - ~3 MB installer

Project Structure

flare/
├── src-tauri/           # Tauri + Rust application
│   ├── src/
│   │   ├── main.rs      # CLI entry point (clap)
│   │   ├── lib.rs       # Tauri setup, HTML gen, file watcher
│   │   ├── markdown.rs  # Markdown-to-HTML renderer (pulldown-cmark)
│   │   ├── themes.rs    # Embedded CSS themes
│   │   └── toc.rs       # Table of contents generator
│   ├── icons/           # App icons (all sizes)
│   ├── Cargo.toml       # Rust dependencies
│   └── tauri.conf.json  # Tauri configuration
├── bin/                 # Node shim for npm install
├── scripts/             # npm postinstall (binary download)
├── docs/                # Spec and design docs
├── package.json         # npm package config
└── README.md

License

Unlicensed. Internal use.