Skip to content

docs: add md2view documentation to README #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arran4 merged 2 commits into from
Jul 13, 2026
Merged

docs: add md2view documentation to README #53

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac3cf1a
docs: add md2view usage to README
google-labs-jules[bot] Jul 13, 2026
9fd486a
docs: update md2view usage example in README
google-labs-jules[bot] Jul 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Clone and build:
git clone https://github.com/arran4/md2png.git
cd md2png
go build ./cmd/md2png
go build ./cmd/md2view
```

Dependencies are pure Go packages:
Expand Down Expand Up @@ -94,6 +95,22 @@ echo "# Hello\nThis came from stdin!" | ./md2png -out hello.png

---

## md2view usage

`md2view` is a GUI viewer for Markdown. It supports the same flags as `md2png` for theming, fonts, width, and margins, but renders the Markdown in a zoomable, pannable desktop window instead of saving it to an image.

```bash
./md2view README.md
```

### Controls

- **Pan/Scroll:** Left Click and Drag, Arrow Keys, or PageUp/PageDown.
- **Zoom In/Out:** Mouse Wheel Up/Down, or `+` / `-` keys.
- **Quit:** `ESC` or `Q`.

---

## Library usage

```go
Expand Down
Loading