Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,14 @@ This is a fork of @snowdog/vuepress-plugin-pdf-export. All changes are available
- Designed to work well in headless environments like CI runners
- Can filter and sort pages.
- Can generate a rudimentary table of contents
- Can insert a front page (or front pages)

## Config options
- `theme` - theme name (default `@vuepress/default`)
- `sorter` - function for changing pages order (default `false`)
- `filter` - function for filtering the pages (default `false`)
- `tocLevel` - function returning a TOC level for the pages, i.e. zero or one (default `false`)
- `frontPage` - path to a pdf to inject first in the document. Typically a front page, but can be multiple pages too.
- `outputFileName` - name of output file (default `site.pdf`)
- `puppeteerLaunchOptions` - [Puppeteer launch options object](https://github.com/puppeteer/puppeteer/blob/v2.1.1/docs/api.md#puppeteerlaunchoptions) (default `{}`)
- `pageOptions` - [Puppeteer page formatting options object](https://github.com/puppeteer/puppeteer/blob/v2.1.1/docs/api.md#pagepdfoptions) (default `{format: 'A4'}`)
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@e8johan/vuepress-plugin-pdf-export",
"version": "1.3.0",
"version": "1.4.0",
"license": "MIT",
"repository": "e8johan/vuepress-plugin-pdf-export",
"scripts": {
Expand Down
2 changes: 2 additions & 0 deletions src/extendCli.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ module.exports = options => {
const sorter = options.sorter || false
const filter = options.filter || false
const tocLevel = options.tocLevel || false
const frontPage = options.frontPage || false
const outputFileName = options.outputFileName || 'site.pdf'
const puppeteerLaunchOptions = options.puppeteerLaunchOptions || {}
const pageOptions = options.pageOptions || {}
Expand Down Expand Up @@ -37,6 +38,7 @@ module.exports = options => {
sorter,
filter,
tocLevel,
frontPage,
outputFileName,
puppeteerLaunchOptions,
pageOptions
Expand Down
8 changes: 8 additions & 0 deletions src/generatePdf.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ module.exports = async (ctx, {
sorter,
filter,
tocLevel,
frontPage,
outputFileName,
puppeteerLaunchOptions,
pageOptions
Expand Down Expand Up @@ -143,6 +144,13 @@ module.exports = async (ctx, {
paddingBottom: 37.6 * pdf.mm,
});

if (frontPage !== false) {
const file = fs.readFileSync(frontPage)
const page = new pdf.ExternalDocument(file)
mergedPdf.addPagesOf(page);
tocPageCount += page.pageCount;
}

if (toc.length > 0) {
_createToc(mergedPdf, toc, tocPageCount);
} else {
Expand Down