convert-md-to-pdf

convert-md-to-pdf

🔨 Convert Markdown file to PDF file

Give a ⭐️ if this project helped you!

Features

• ✅ Build PDF file form Markdown file
• ✅ Generate a PDF file in the same directory as the Markdown file
• ✅ Use one of the built-in themes
• ✅ Support custom path to a theme file
• ✅ Support set output directory and output file name
• ✅ Support paper orientation (portrait, landscape)
• ✅ Support paper border (default: 2cm for all sides)

Usage

Installation:

npm install convert-md-to-pdf

const { buildPDF } = require('convert-md-to-pdf');
buildPDF({
  source: '/tmp/source.md',
  target: '/tmp/document.pdf',
});

CLI

Installation:

npm install -g convert-md-to-pdf

➡️ Use case: Regular usage

convert-md-to-pdf /tmp/source.md

➡️ Use case: Display list of built-in themes

convert-md-to-pdf -l

➡️ Use case: Change theme (built-in)

convert-md-to-pdf /tmp/source.md -t clean
convert-md-to-pdf /tmp/source.md -t dark
convert-md-to-pdf /tmp/source.md -t paper
convert-md-to-pdf /tmp/source.md -t nord
convert-md-to-pdf /tmp/source.md -t orange

➡️ Use case: Custom theme

convert-md-to-pdf /tmp/source.md -p ~/custom-theme.css
convert-md-to-pdf /tmp/source.md --theme-path ~/custom-theme.css

➡️ Use case: Set directory for output file

convert-md-to-pdf /tmp/source.md -d my-files/
convert-md-to-pdf /tmp/source.md --directory my-files/

➡️ Use case: Set name of output file

convert-md-to-pdf /tmp/source.md -o agreement.pdf
convert-md-to-pdf /tmp/source.md --output agreement.pdf

➡️ Use case: Change paper orientation (default: portrait)

convert-md-to-pdf /tmp/source.md -m landscape
convert-md-to-pdf /tmp/source.md --mode landscape

➡️ Use case: Change paper border (default: 2cm for all sides)

# order of values: top, right, bottom, left
convert-md-to-pdf /tmp/source.md -b 1cm,1cm,1cm,1cm
convert-md-to-pdf /tmp/source.md --border 2cm,3cm,2cm,3cm

➡️ Use case: Display the date of generation in the output file

During the conversion, the following phrase will be replaced with date & time. For example:

Generated on: $$SIGNATURE$$

It will be replaced with:

Generated on: 2023-09-08 23:16:35

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Related

• convert-md-to-html - 🔨 Convert Markdown file to HTML file

Credits

Thanks to the authors of markdown-pdf

License

The MIT License @ 2018