Skip to content

BuildDownAI/mdview

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mdview

mdview is a native terminal Markdown viewer with styled rendering and pager-style navigation.

Features

  • Single native executable.
  • Rich terminal rendering for common Markdown.
  • Pager-style keyboard navigation.
  • Syntax-highlighted fenced code blocks when a language is specified.
  • Plain code rendering for unlabeled or unknown-language code blocks.

Build

cargo build --release

The single executable is written to:

target/release/mdview

Use

target/release/mdview sample.md

To install it somewhere on your PATH, copy target/release/mdview after building.

Keybindings:

  • q / Esc: quit
  • j / Down: scroll down
  • k / Up: scroll up
  • Space / PageDown: page down
  • b / PageUp: page up
  • g: top
  • G: bottom

Supported Markdown includes headings, emphasis, inline code, syntax-highlighted fenced code blocks, links, blockquotes, lists, horizontal rules, and tables. Code fences are not shown in the rendered view.

License

Licensed under the Apache License, Version 2.0. See LICENSE.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages