A plugin, support export site to a pdf file.[#546]

package.json

@@ -15,7 +15,8 @@
     "lint": "eslint --fix packages/**/*.js packages/**/*.vue packages/**/bin/*",
     "release": "yarn --pure-lockfile && node scripts/release.js",
     "changelog": "node scripts/genChangelog.js run",
-    "test": "node scripts/test.js"
+    "test": "node scripts/test.js",
+    "debug":"lerna exec --scope docs -- yarn debug"
   },
   "gitHooks": {
     "pre-commit": "lint-staged"

packages/@vuepress/plugin-export-site/.npmignore

@@ -0,0 +1,2 @@
+__tests__
+__mocks__

packages/@vuepress/plugin-export-site/README.md

@@ -0,0 +1,3 @@
+# @vuepress/plugin-export-site
+
+> export-site plugin for vuepress

packages/@vuepress/plugin-export-site/export.js

@@ -0,0 +1,57 @@
+const puppeteer = require('puppeteer')
+const PDFMerge = require('easy-pdf-merge')
+const { path, fs, logger } = require('@vuepress/shared-utils')
+
+module.exports = async ({ extension, sourceDir, pages, dest, enabled }) => {
+  if (!enabled) return
+  if (extension === 'pdf') {
+    await exportPDF({ sourceDir, pages, dest })
+  } else {
+    logger.warn(`Not support ${extension} format site export!`)
+  }
+}
+
+async function exportPDF ({ sourceDir, pages = [], dest }) {
+  try {
+    const paths = pages.map(s => s.path)
+    const pdfTempDir = path.resolve('./_tempPDF')
+    fs.ensureDirSync(pdfTempDir)
+    const browser = await puppeteer.launch()
+    const page = await browser.newPage()
+    // port finder
+    const options = paths.map(path => {
+      return {
+        location: `http://localhost:8080${path}`,
+        path: `${pdfTempDir}/${path.replace(/\//g, '-').replace('-', '').replace(/\.html/, '').replace(/-$/, '')}.pdf`
+      }
+    })
+    const files = options.map(option => path.resolve(option.path))
+    await downloadPDFs(page, options)
+    await mergePDF(files, dest)
+    await browser.close()
+    fs.removeSync(pdfTempDir)
+  } catch (e) {
+    logger.error(e.stack)
+  }
+}
+
+async function downloadPDFs (page, options) {
+  for (let i = 0; i < options.length; i++) {
+    const { location, path } = options[i]
+    await page.goto(location, { waitUntil: 'networkidle2' })
+    await page.pdf({ path, format: 'A4' })
+    logger.success(`pdf ${path} generator success`)
+  }
+}
+
+function mergePDF (files, exportFile = 'site') {
+  return new Promise((resolve, reject) => {
+    PDFMerge(files, `${exportFile}.pdf`, (err) => {
+      if (err) {
+        reject(err)
+      }
+      logger.success(`export ${exportFile}.pdf file success!`)
+      resolve()
+    })
+  })
+}

packages/@vuepress/plugin-export-site/index.js

@@ -0,0 +1,17 @@
+const siteExport = require('./export')
+
+module.exports = (options = {}, ctx) => {
+  return {
+    async ready () {
+      setTimeout(() => {
+        siteExport({
+          extension: options.extension,
+          sourceDir: ctx.sourceDir,
+          pages: ctx.pages,
+          dest: ctx.outDir,
+          enabled: !ctx.isProd
+        }, 0)
+      })
+    }
+  }
+}

packages/@vuepress/plugin-export-site/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@vuepress/plugin-export-site",
+  "version": "1.0.0-alpha.8",
+  "description": "export-site plugin for vuepress",
+  "main": "index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vuejs/vuepress.git"
+  },
+  "dependencies": {
+    "easy-pdf-merge": "^0.1.3",
+    "puppeteer": "^1.7.0"
+  },
+  "keywords": [
+    "documentation",
+    "vue",
+    "vuepress",
+    "generator"
+  ],
+  "author": "LinFeng1997 <ynublow@gmail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/vuejs/vuepress/issues"
+  },
+  "homepage": "https://github.com/vuejs/vuepress/packages/@vuepress/plugin-export-site#readme"
+}

packages/docs/docs/.vuepress/config.js

@@ -66,7 +66,10 @@ module.exports = {
     },
     '@vuepress/plugin-medium-zoom': true,
     '@vuepress/notification': true,
-    'flowchart': true
+    'flowchart': true,
+    '@vuepress/export-site': {
+      extension: 'pdf'
+    }
   },
   clientRootMixin: path.resolve(__dirname, 'mixin.js')
 }

packages/docs/package.json

@@ -5,7 +5,8 @@
   "description": "docs of VuePress",
   "scripts": {
     "dev": "vuepress dev docs --temp .temp",
-    "build": "vuepress build docs --temp .temp"
+    "build": "vuepress build docs --temp .temp",
+    "debug": "node --inspect-brk ../vuepress/vuepress.js dev docs --temp .temp"
   },
   "repository": {
     "type": "git",