🔨 Convert Markdown file to PDF.
Give a ⭐️ if this project helped you!
- ✅ 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
const { buildPDF } = require('convert-markdown-to-pdf');
buildPDF({
source: '/tmp/source.md',
target: '/tmp/document.pdf'
});
npm install -g convert-markdown-to-pdf
convert-markdown-to-pdf /tmp/source.md
convert-markdown-to-pdf -l
convert-markdown-to-pdf /tmp/source.md -t clean
convert-markdown-to-pdf /tmp/source.md -t dark
convert-markdown-to-pdf /tmp/source.md -t default
convert-markdown-to-pdf /tmp/source.md -t nord
convert-markdown-to-pdf /tmp/source.md -t orange
convert-markdown-to-pdf /tmp/source.md -p ~/custom-theme.css
convert-markdown-to-pdf /tmp/source.md --theme-path ~/custom-theme.css
convert-markdown-to-pdf /tmp/source.md -d my-files/
convert-markdown-to-pdf /tmp/source.md --directory my-files/
convert-markdown-to-pdf /tmp/source.md -f agreement.pdf
convert-markdown-to-pdf /tmp/source.md --filename agreement.pdf
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
Contributions, issues and feature requests are welcome!
Feel free to check issues page.
npm run lint
npm run test
npm run coverage
npm run clear
# npm version major / minor / patch
npm publish
git push --tags
The MIT License @ 2018-2024