@snowdog/vuepress-plugin-pdf-export
Vuepress plugin for exporting site as PDF
Features
- Exports whole Vuepress based page as a single PDF file
- Applies styles to hide UI elements like navigation or sidebar
- Doesn't other languages like Java to run
- Designed to work well in headless environments like CI runners
Config options
-
theme
- theme name (default@vuepress/default
) -
sorter
- function for changing pages order (defaultfalse
) -
outputFileName
- name of output file (defaultsite.pdf
) -
puppeteerLaunchOptions
- Puppeteer launch options object (default{}
) -
pageOptions
- Puppeteer page formatting options object (default{format: 'A4'}
) -
excludedPages
- array of urls to exclude from output file
Usage
Using this plugin:
// in .vuepress/config.js
module.exports = {
plugins: ['@snowdog/vuepress-plugin-pdf-export']
}
Then run:
vuepress export [path/to/your/docs]
Tips
To run this plugin on Gitlab CI you may want to run Chrome with no-sandbox
flag. Details
module.exports = {
plugins: [
['@snowdog/vuepress-plugin-pdf-export', {
puppeteerLaunchOptions: {
args: ['--no-sandbox', '--disable-setuid-sandbox']
}
}]
]
}