convert-md-to-pdf
v1.1.3
Published
Convert Markdown file to PDF
Downloads
42
Maintainers
Readme
convert-md-to-pdf
:hammer: Convert Markdown file to PDF file
Give a ⭐️ if this project helped you!
Features
- :white_check_mark: Build PDF file form Markdown file
- :white_check_mark: Generate a PDF file in the same directory as the Markdown file
- :white_check_mark: Use one of the built-in themes
- :white_check_mark: Support custom path to a theme file
- :white_check_mark: Support set output directory and output file name
Usage
const { buildPDF } = require('convert-md-to-pdf');
buildPDF({
source: '/tmp/source.md',
target: '/tmp/document.pdf'
});
Installation
npm install -g convert-md-to-pdf
CLI
:arrow_right: Use case: Regular usage
convert-md-to-pdf /tmp/source.md
:arrow_right: Use case: Display list of built-in themes
convert-md-to-pdf -l
:arrow_right: 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 default
convert-md-to-pdf /tmp/source.md -t nord
convert-md-to-pdf /tmp/source.md -t orange
:arrow_right: 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
:arrow_right: 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/
:arrow_right: Use case: Set name of output file
convert-md-to-pdf /tmp/source.md -f agreement.pdf
convert-md-to-pdf /tmp/source.md --filename agreement.pdf
:arrow_right: 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 - :hammer: Convert Markdown file to HTML file
Credits
Thanks to the authors of markdown-pdf
License
The MIT License @ 2018-2024