ryan-crabbe / mdui Public

Notifications You must be signed in to change notification settings
Fork 0
Star 0

A terminal Markdown viewer with seamless editor integration

0 stars 0 forks Branches Tags Activity

Notifications

Name		Name	Last commit message	Last commit date
Latest commit History 7 Commits
.gitignore		.gitignore
.golangci.yml		.golangci.yml
PLAN.md		PLAN.md
README.md		README.md
go.mod		go.mod
go.sum		go.sum
main.go		main.go
model.go		model.go
render.go		render.go

Repository files navigation

mdui

Terminal-based Markdown viewer with editor integration.

Installation

Requires Go 1.21 or later.

go install github.com/ryan-crabbe/mdui@latest

Usage

mdui <file.md>

Keybindings

Key	Action
`j` / `↓`	Scroll down
`k` / `↑`	Scroll up
`d` / `PgDn`	Half-page down
`u` / `PgUp`	Half-page up
`g`	Go to top
`G`	Go to bottom
`e`	Open in editor
`r`	Reload file
`?` / `h`	Show help
`q` / `Ctrl+C`	Quit

Configuration

$EDITOR - Editor command for e key (defaults to nvim)

Limitations

Maximum file size: 100MB

About

A terminal Markdown viewer with seamless editor integration

Report repository

Releases

No releases published

Packages

No packages published

Languages

Go 100.0%