Skip to content
/ md2pdf Public

๐Ÿ“œ Generate PDFs from Markdown files

License

Notifications You must be signed in to change notification settings

tcd/md2pdf

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

md2pdf

Build Status Coverage Status GitHub issues FOSSA Status License

fancy-gif

About

Parse markdown files and output PDFs that resemble GitHub's markdown rendering.

What's Supported?

  • Paragraphs
  • Blockquotes
  • Codeblocks
    • Syntax highlighting provided by Chroma
  • All kinds of emphasis:
    • Bold
    • Italic
    • Code
    • Strike
    • Links
  • Images
    • jpeg, png, and gif*
      • Only the first frame of a gif is drawn to the pdf ๐Ÿ˜”
  • Headers
  • Horizontal Rules
  • Links
    • Links on images
    • External Links
  • Tables

What Isn't Supported?

Installation

Homebrew

brew tap tcd/taps
brew install tcd/taps/md2pdf

Building from Source

go get -u github.com/tcd/md2pdf
cd $GOPATH/github.com/tcd/md2pdf
make install # GO111MODULE=on go install

Usage

# will generate markdown-file.pdf in your current directory.
md2pdf path/to/markdown-file.md

Related Projects

License

FOSSA Status