Export your VuePress site to a PDF file
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example init Jan 27, 2019
test init Jan 27, 2019
.editorconfig init Jan 27, 2019
.gitattributes init Jan 27, 2019
.gitignore init Jan 27, 2019
.release-it.json ci: setup release Jan 27, 2019
CHANGELOG.md chore: changelog Jan 27, 2019
LICENSE init Jan 27, 2019
README.md chore: readme Jan 27, 2019
index.js feat: disable internal webpack log plugin Jan 27, 2019
package.json 0.1.0 Jan 27, 2019
site.pdf
yarn.lock init Jan 27, 2019

README.md

vuepress-plugin-export

NPM version NPM downloads CircleCI

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

Features

  • Merge all of your pages automatically.

TODO

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

Install

npm i vuepress-plugin-export

Usage

Using this plugin:

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

Then run:

vuepress export [path/to/your/docs]

Development

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

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

PUPPETEER_DOWNLOAD_HOST=https://npm.taobao.org/mirrors

Contributing

  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

Author

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