Terminal Markdown previewer — GUI-like experience.
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

Merge pull request #46 from RivoLink/docs/clean-up-readme-sections

docs: clean-up readme sections

authored by

Rivo Link and committed by
GitHub
88554798 4329fafe

+9 -24
+9 -24
README.md
··· 144 144 145 145 ## Features 146 146 147 - - ✅ **Watch mode** `--watch` / `-w` — reloads every 250ms, with `⟳ reloaded` flash feedback 148 - - ✅ `leaf --watch` can start from the picker and begin watching after file selection 149 - - ✅ Syntax highlighting with common language aliases like `py`, `cpp`, `json`, `toml`, `ps1`, and `dockerfile` 150 - - ✅ Unicode box-drawing tables with left / center / right alignment 151 - - ✅ TOC sidebar with active section tracking and two-level navigation 152 - - ✅ Search with match highlighting, `/`, `Ctrl+F`, and `n` / `N` 153 - - ✅ Code blocks `┌─ lang ───┐` 154 - - ✅ LaTeX math rendering — inline `$...$` and display `$$...$$` with Unicode conversion via `unicodeit` 155 - - ✅ LaTeX code blocks `` ```latex `` / `` ```tex `` rendered as formula blocks 156 - - ✅ Bold, italic, strikethrough, blockquotes, lists, and horizontal rules 157 - - ✅ YAML frontmatter is ignored in both preview and TOC 158 - - ✅ Native stdin input with bounded size 159 - - ✅ `leaf --update` to fetch, verify via published SHA256, and install the latest release on supported platforms 160 - - ✅ Fuzzy Markdown picker when launched without a file, or anytime with `Ctrl+P` 161 - - ✅ Classic directory browser picker with `leaf --picker`, or anytime with `Shift+P` 162 - - ✅ Theme picker with runtime preview 163 - - ✅ Help popup with in-app shortcuts 147 + - **Live preview** — Watch mode with automatic reload and visual feedback. 148 + - **File picker** — Fuzzy Markdown picker, directory browser, and watch after selection. 149 + - **Editor integration** — Open the current file in your preferred editor. 150 + - **Rich Markdown rendering** — Tables, lists, blockquotes, rules, bold, italic, and strikethrough. 151 + - **Syntax highlighting** — Common aliases like `py`, `cpp`, `json`, `toml`, `ps1`, `dockerfile`. 152 + - **LaTeX support** — Inline, block, and `latex` / `tex` code blocks rendered as formulas. 153 + - **Navigation** — TOC sidebar, active section tracking, heading jumps, and search. 154 + - **Terminal UX** — Theme picker, help popup, file path popup, mouse and keyboard support. 155 + - **CLI friendly** — stdin support and `leaf --update` with SHA256 verification. 164 156 165 157 ## Typical AI Workflow 166 158 ··· 171 163 # Terminal 2: live watch 172 164 leaf --watch notes.md 173 165 ``` 174 - 175 - ## Roadmap 176 - 177 - - [x] Themes (light / custom) 178 - - [ ] Copy code block `y` 179 - - [ ] Code block horizontal scroll 180 - - [ ] Improve search performance on large files 181 166 182 167 ## Troubleshooting 183 168