A Markdown reader for your terminal

Markdown,
at home in
your terminal.

Read files, search text, navigate headings, and follow Markdown streams without leaving your terminal.

Install Gezi macOS · Apple Silicon
ge reading.mdMarkdown source
Reading with Gezi
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

在终端里,读得自在。

Open a document or read Markdown from a pipe.

  sh                                                            
  ge README.md                                                  
  cat notes.md | gezi                                           

┌───────────┬────────────────────────┐
│ Keys      │ In the reader          │
├───────────┼────────────────────────┤
│ / + Enter │ Search text            │
│ n / N     │ Next / previous match  │
│ o / Tab   │ Outline / switch panes │
└───────────┴────────────────────────┘

Files are read-only. Editing is not yet available.
Reading with Gezi
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

在终端里,读得自在。

Open a document or read Markdown
from a pipe.

  sh                              
  ge README.md                    
  cat notes.md | gezi             

┌───────────┬────────────────────┐
│ Keys      │ In the reader      │
├───────────┼────────────────────┤
│ / + Enter │ Search text        │
│ n / N     │ Next / previous    │
│           │ match              │
│ o / Tab   │ Outline / switch   │
│           │ panes              │
└───────────┴────────────────────┘

Files are read-only. Editing is
not yet available.
gezi 0.1.9 · renderer outputRead-only

Open a Markdown file

Formatted headings, highlighted code, and tables.

ge README.md

Find text and headings

Search with / and Enter. Open the outline with o.

/ Enter · n N · o Tab

Read from a pipe

Send Markdown into Gezi from another command.

cat notes.md | gezi

Run this command in your terminal.

curl -fsSL https://raw.githubusercontent.com/HiAriesZhou/Gezi/main/install.sh | sh

Installs gezi and ge to ~/.local/bin.