Skip to content

feat: Add option to exclude pages #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: Add option to exclude pages #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Vuepress plugin for exporting site as PDF
- `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'}`)
- `excludedPages` - array of urls to exclude from output file

### Usage

Expand Down
2 changes: 2 additions & 0 deletions src/extendCli.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ module.exports = options => {
const outputFileName = options.outputFileName || 'site.pdf'
const puppeteerLaunchOptions = options.puppeteerLaunchOptions || {}
const pageOptions = options.pageOptions || {}
const excludedPages = options.excludedPages || []

return cli => {
cli
Expand All @@ -33,6 +34,7 @@ module.exports = options => {
port: nCtx.devProcess.port,
host: nCtx.devProcess.host,
sorter,
excludedPages,
outputFileName,
puppeteerLaunchOptions,
pageOptions
Expand Down
7 changes: 6 additions & 1 deletion src/generatePdf.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ module.exports = async (ctx, {
sorter,
outputFileName,
puppeteerLaunchOptions,
pageOptions
pageOptions,
excludedPages
}) => {
const { pages, tempPath } = ctx
const tempDir = join(tempPath, 'pdf')
Expand All @@ -31,6 +32,10 @@ module.exports = async (ctx, {
}
})

if (Array.isArray(excludedPages)) {
exportPages = exportPages.filter(page => !excludedPages.includes(page.url))
}

const browser = await puppeteer.launch(puppeteerLaunchOptions)
const browserPage = await browser.newPage()

Expand Down