ulivz / vuepress-plugin-export

Export your VuePress site to a PDF file

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool


NPM version NPM downloads

This plugin requires VuePress >= 1.0.0-alpha.44.


  • Merge all of your pages automatically.


  • Support default and confurable front cover.
  • Inject Table of Contents.
  • Inject Page Numbers.
  • Generate different PDF files per locale.
  • Transform all of links.


npm i vuepress-plugin-export


Using this plugin:

// .vuepress/config.js
module.exports = {
  plugins: ['vuepress-plugin-export']

Then run:

vuepress export [path/to/your/docs]

Generating multiple output files

You can configure this plugin to export multiple files. Add config options:

module.exports: ['vuepress-plugin-export', {
  theme: '@vuepress/default',
  puppeteer: { args: ['--no-sandbox'] },
  bundles: [{
    filter: (location) => !location.includes('export'),
    dest: () => 'docs/public/export.pdf',
  }, {
    filter: /\/en\///,
    dest: (siteConfig) => `docs/public/${siteConfig.title}.en.pdf`,

Then run:

vuepress export [path/to/your/docs]

Config options

  • theme: String
  • puppeteer: Object
  • bundles: Array | Function(Array[PageConfig]) => Array[bundle]
  • bundles[].filter: RegExp | Function(location: string, page: PageConfig) => boolean
  • bundles[].dest: (config: VuepressPluginConfig(https://vuepress.vuejs.org/config/#basic-config)) => string
  • bundles[].sorter: Function(PageConfig, PageConfig) => -1, 0, 1

with PageConfig:

url: string
location: string
title: string
path: string


git clone https://github.com/ulivz/vuepress-plugin-export
cd vuepress-plugin-export
yarn export

Note that this package is powered by puppeteer, if you are in a mysterious wall, consider setting environment variables before installation.


Note that this pavkage is powered by easy-pdf-merge, Java 6 or higher must be present.


  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D


vuepress-plugin-export © ULVIZ, Released under the MIT License.
Authored and maintained by ULVIZ with help from contributors (list).

github.com/ulivz · GitHub @ULVIZ · Twitter @_ulivz


Export your VuePress site to a PDF file

License:MIT License


Language:JavaScript 100.0%