md_reader 0.2.2

A fast, native markdown reader and editor with live preview, syntax highlighting, and multi-file support.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

# md_reader

[![crates.io](https://img.shields.io/crates/v/md_reader.svg)](https://crates.io/crates/md_reader)

A fast, native desktop markdown reader and editor built with [egui](https://github.com/emilk/egui) and the help of Claude. Open a folder and browse your notes with live preview, syntax-highlighted code blocks, and a persistent session that remembers where you left off.

---

## Features

- **Three view modes** — Preview, Edit, and Split (side-by-side)
- **Live preview** — rendered markdown updates as you type in Split/Edit mode
- **Syntax highlighting** — code blocks highlighted via [syntect](https://github.com/trishume/syntect)
- **File-tree sidebar** — browse folders, open multiple files as tabs
- **Document outline** — collapsible heading tree with auto-scroll tracking
- **Full-text search** — Ctrl+F with case-sensitive and whole-word options
- **Four themes** — Light (Manuscript), Coal, Navy, Ayu
- **Zoom** — Ctrl+Scroll to scale content independently of the UI
- **File watching** — auto-reloads files edited externally
- **Session persistence** — restores open tabs, view mode, theme, and zoom on restart
- **Unsaved-changes guard** — prompts before closing a modified file

---

## Preview

| Split mode (light theme) | Preview mode (coal theme) |
|---|---|
| ![md_reader Split mode light theme](https://raw.githubusercontent.com/bauj/md_reader/main/assets/screenshots/md_reader_preview_light_split.png) | ![md_reader Preview mode coal theme](https://raw.githubusercontent.com/bauj/md_reader/main/assets/screenshots/md_reader_preview_coal_preview.png) | 

| Split mode (ayu theme) | Split mode (navy theme) |
|---|---|
| ![md_reader Split mode ayu theme](https://raw.githubusercontent.com/bauj/md_reader/main/assets/screenshots/md_reader_preview_ayu_split.png) | ![md_reader Split mode navy theme](https://raw.githubusercontent.com/bauj/md_reader/main/assets/screenshots/md_reader_preview_navy_split.png) | 

---

## Installation

```bash
cargo install md_reader
```

> **Requirements:** a C compiler and system libraries for your platform (standard Rust toolchain setup). On Linux, you may need `libxcb` / `libwayland` dev packages depending on your desktop environment.

---

## Usage

```bash
# Open the current directory
md_reader

# Open a specific folder
md_reader path/to/notes/

# Open a specific file (also loads its parent directory into the sidebar)
md_reader path/to/file.md
```

---

## Keyboard Shortcuts

| Shortcut | Action |
|---|---|
| `Ctrl+O` | Open folder |
| `Ctrl+N` | New file |
| `Ctrl+S` | Save current file |
| `Ctrl+W` | Close current tab |
| `Ctrl+Q` | Quit |
| `Ctrl+B` | Toggle sidebar |
| `Ctrl+F` | Open search bar |
| `Ctrl+PageUp` | Previous tab |
| `Ctrl+PageDown` | Next tab |
| `PageUp / PageDown` | Scroll preview |
| `Ctrl+Scroll` | Zoom content in/out |
| `Escape` | Close search bar |

---

## Build from Source

```bash
git clone https://github.com/bauj/md_reader
cd md_reader
cargo build --release
./target/release/md_reader
```

---

## License

MIT — see [LICENSE](LICENSE).

## Fonts

All fonts are licensed under the [SIL Open Font License 1.1](https://openfontlicense.org). License texts are included in [`assets/fonts/licenses/`](assets/fonts/licenses/).

| Font | Role |
|---|---|
| [JetBrains Mono](https://www.jetbrains.com/legalnotice/jetbrainsmono/) | Code blocks and editor (monospace) |
| [Outfit](https://fonts.google.com/specimen/Outfit) | UI chrome (toolbar, sidebar, menus) |
| [Rubik](https://fonts.google.com/specimen/Rubik) | Preview body text — **default** |
| [Nunito](https://fonts.google.com/specimen/Nunito) | Preview body text — selectable |
| [Figtree](https://fonts.google.com/specimen/Figtree) | Preview body text — selectable |
| [Manrope](https://fonts.google.com/specimen/Manrope) | Preview body text — selectable |
| [Source Sans 3](https://fonts.google.com/specimen/Source+Sans+3) | Preview body text — selectable |