Skip to content

CLI tool for viewing fully-rendered Markdown from within the terminal

License

Notifications You must be signed in to change notification settings

Sabnock01/mdvew

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mdvew

Render markdown files as images in the terminal.

Install

cargo install mdvew

Requires Chrome or Chromium installed on your system.

Usage

mdvew README.md              # display in terminal
mdvew README.md -t dark      # dark mode
mdvew README.md -o out.png   # save to file
mdvew README.md -b           # open in browser

Options

Flag Description
-o, --output <FILE> Save PNG instead of displaying
-t, --theme <light|dark> Color theme (default: light)
-b, --browser Open in system browser
-w, --viewport-width <PX> Render width in pixels (default: auto)

Acknowledgements

  • viuer - Terminal image display
  • viu - Inspiration for terminal image viewing
  • github-markdown-css - GitHub-flavored markdown styling
  • glow - Terminal markdown rendering
  • inlyne - GPU-native markdown rendering

About

CLI tool for viewing fully-rendered Markdown from within the terminal

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published