Skip to content

1.0.0

Latest
Latest

Choose a tag to compare

View all tags
@github-actions github-actions released this 20 Aug 09:48
1.0.0
d794bfc

mdview 1.0.0

First public release. mdview is a read-only terminal Markdown viewer: one Document, rendered for reading, not source.

cargo install mdviewer --locked
mdview README.md
git show HEAD:README.md | mdview

The crate is mdviewer (binary mdview). mdview on crates.io is a different project.

What's in

  • CommonMark plus GFM: headings, lists, task lists, tables, footnotes, alerts, YAML front matter, syntax-highlighted fenced code
  • Outline that tracks the current section
  • Vim-like motions, counts, scrolling, jump history (? for the keymap)
  • Literal search (/ n N)
  • Characterwise / rowwise selection, yank to clipboard
  • gx for fragments, footnotes, and explicit HTTP(S) links
  • Reload of file-backed Documents (r), position kept when possible
  • Stdin Documents (mdview -)
  • Inert content: no fetch, no HTML execution, no mouse capture

Install

  • crates.io: cargo install mdviewer --locked (Rust 1.88+)
  • Prebuilt archives (Linux musl, macOS):
    • mdview-1.0.0-x86_64-unknown-linux-musl.tar.gz
    • mdview-1.0.0-aarch64-unknown-linux-musl.tar.gz
    • mdview-1.0.0-x86_64-apple-darwin.tar.gz
    • mdview-1.0.0-aarch64-apple-darwin.tar.gz

Not in v1

Editing, config, source mode, auto-watch, network fetch, stable library API, Windows as a supported target.

MIT. Docs: https://github.com/xenoninja/markdown-viewer

Assets 10
Loading