# @condorhero/vuepress-plugin-export-pdf-v2
`@condorhero/vuepress-plugin-export-pdf-v2` is a VuePress 2.x plugin that allows you to export your sites to a PDF file with **outlines or bookmarks**.
## Related
- [vitepress-export-pdf](https://github.com/condorheroblog/vitepress-export-pdf)
- [@condorhero/vuepress-plugin-export-pdf-v1](https://github.com/condorheroblog/vuepress-plugin-export-pdf/blob/main/packages/vuepress-plugin-export-pdf-v1/README.md)
## Installation
```sh
npm install @condorhero/vuepress-plugin-export-pdf-v2 -D
```
then add script to your `package.json`:
```json
{
"scripts": {
"export-pdf": "press-export-pdf export [path/to/your/docs]"
}
}
```
Then run:
```sh
npm run export-pdf
```
## `press-export-pdf` Command Options
The package provides the `press-export-pdf` command with the following command line options:
- `export [sourceDir]`: Export your site to a PDF file
- `-c, --config `: Set path to config file
- `--outFile `: Name of output file
- `--outDir `: Directory of output files
- `--pdfOutlines `: Keep PDF outlines/bookmarks([**Node >= 18.5.0**](https://github.com/condorheroblog/vuepress-plugin-export-pdf/tree/v3.0.1/packages/vuepress-plugin-export-pdf-v2#qa))
- `--urlOrigin `: Change the origin of the print url(Option `displayHeaderFooter` of `pdfOptions` is true)
- `--debug`: Enable debug mode
- `info`: Display environment information
- `--help`: Display help information
- `--version`: Display version information
## Config File Options
You can create a new config file, we support the following files:
- `vuepress-pdf.config.ts`
- `vuepress-pdf.config.js`
- `vuepress-pdf.config.cjs`
- `vuepress-pdf.config.mjs`
- `.vuepress/vuepress-pdf.config.ts`
- `.vuepress/vuepress-pdf.config.js`
- `.vuepress/vuepress-pdf.config.cjs`
- `.vuepress/vuepress-pdf.config.mjs`
In addition, you can also customize the configuration file through `--config` or `-c`.
It is recommended to use TS(`.vuepress/vuepress-pdf.config.ts`) files, which are easy to manage and have **friendly code prompts**.
ex:
```ts
// .vuepress/vuepress-pdf.config.ts
import { defineUserConfig } from '@condorhero/vuepress-plugin-export-pdf-v2'
export default defineUserConfig({
theme: '@vuepress/theme-default',
})
```
if you want to use JS files, **you can leverage your IDE's intellisense with jsdoc type hints**:
```js
/**
* @type {import('@condorhero/vuepress-plugin-export-pdf-v2').UserConfig}
*/
const config = {
// ...
}
export default config
```
config options:
- `theme` - theme name (default `@vuepress/default`)
- `bundler` - VuePress bundler name (default `vuepress-vite`)
- `sorter` - function for changing pages order (default `undefined`)
- `outFile` - name of output file (default `vuepress-YYMMDD-HHmmss.pdf`)
- `outDir` - Directory of output files (default `package.json` file exists in directory)
- `routePatterns` - Specify the patterns of files you want to be exported. The patterns are relative to the source directory (default `["/**", "!/404.html"]`).Patterns to match Route path using [multimatch](https://github.com/sindresorhus/multimatch)
- `puppeteerLaunchOptions` - [Puppeteer launch options object](https://github.com/puppeteer/puppeteer/blob/main/docs/api/puppeteer.puppeteerlaunchoptions.md)
- `pdfOptions` - [Valid options to configure PDF generation via Page.pdf()](https://github.com/puppeteer/puppeteer/blob/main/docs/api/puppeteer.pdfoptions.md) (default `{ format: 'A4 }`), **`pageNumber` and `totalPages` of `headerTemplate` and `footerTemplate` cannot be used because of [this reason](https://github.com/condorheroblog/vitepress-export-pdf/issues/5)**
- `pdfOutlines` - Keep PDF outlines/bookmarks(default `true`)
- `urlOrigin`: Change the origin of the print url(Option `displayHeaderFooter` of `pdfOptions` is true) - ([How do I change the URL point to the localhost](https://github.com/condorheroblog/vuepress-plugin-export-pdf/issues/5))
- `outlineContainerSelector`: Specify an outline container selector.
## Examples
A usable example of quick start [click here](https://github.com/condorheroblog/vuepress-plugin-export-pdf/tree/main/packages/vuepress-plugin-export-pdf-v2/example/vuepress-next).
### Order of PDF
`console.log` all the routes in the sort function and assign them to the variable `routeOrder` as a value. You can adjust the order of printing in the array `routeOrder`.
```ts
import { defineUserConfig } from 'vitepress-export-pdf'
const routeOrder = [
'/index.html',
'/guide/what-is-vitepress.html',
'/guide/getting-started.html',
'/guide/configuration.html',
// ...
]
export default defineUserConfig({
sorter: (pageA, pageB) => {
const aIndex = routeOrder.findIndex(route => route === pageA.path)
const bIndex = routeOrder.findIndex(route => route === pageB.path)
return aIndex - bIndex
},
})
```
### Discard your outlines/bookmarks
`.vuepress/vuepress-pdf.config.ts` add `pdfOutlines`:
```ts
export default defineUserConfig({
pdfOutlines: false,
})
```
### Don't export homepage
`.vuepress/vuepress-pdf.config.ts` add `routePatterns`:
```ts
export default defineUserConfig({
routePatterns: ['!/'],
})
```
> Note: `!` at the beginning of a pattern will negate the match
### PDF print style
By default, `A4` paper is used for printing, The size of A4 paper is (8.27in x 11.7in), One inch is equal to ninety-six pixels: `1 in = 96 pixel (X)` ,the inch unit of A4 is converted to (793.92px x 1123.2px).
The layout of VuePress itself is responsive, which should meet your needs. If you change the size of the printing paper or don't want some styles on the website to be input into PDF, you need to simply write some CSS styles.
It is recommended that you change it in the [global style](https://v2.vuepress.vuejs.org/reference/default-theme/styles.html) of VuePress(`.vuepress/styles/index.scss`), use the `print` of `@media` to control CSS style.
for example:
```css
@media print {
.navbar,
.sidebar,
.sidebar-mask {
display: none;
}
.page {
padding-left: inherit;
}
}
```
## 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
## Report Bug
run `vuepress info` or `press-export-pdf info` Shows debugging information about the local environment.
## License
[MIT](https://github.com/condorheroblog/vuepress-plugin-export-pdf/blob/main/LICENSE)