Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kohheepeace/mr-pdf
Generate PDF for document website.
https://github.com/kohheepeace/mr-pdf
docusaurus mkdocs pdf-generation vuepress
Last synced: 1 day ago
JSON representation
Generate PDF for document website.
- Host: GitHub
- URL: https://github.com/kohheepeace/mr-pdf
- Owner: kohheepeace
- License: mit
- Created: 2020-08-16T15:57:22.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-07-27T07:38:53.000Z (over 1 year ago)
- Last Synced: 2025-01-21T08:07:09.105Z (10 days ago)
- Topics: docusaurus, mkdocs, pdf-generation, vuepress
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/mr-pdf
- Size: 11.2 MB
- Stars: 128
- Watchers: 3
- Forks: 42
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## ⚠️ Caution!
Currently, this package is not catching up with docusaurus v2 HTML markup, so command may not find the correct HTML to loop through docs. Please modify the command to find correct HTML markup by yourself.
## 📌 Introduction
This is a PDF generator from document website such as `docusaurus`, `vuepress`, `mkdocs`.
## ⚡ Usage
For [docusaurus v1](https://v1.docusaurus.io/docs/en/installation)
```shell
npx mr-pdf --initialDocURLs="https://v1.docusaurus.io/docs/en/installation" --paginationSelector=".docs-prevnext > a.docs-next" --excludeSelectors=".fixedHeaderContainer,footer.nav-footer,#docsNav,nav.onPageNav,a.edit-page-link,div.docs-prevnext" --cssStyle=".navPusher {padding-top: 0;}" --contentSelector="article"
```
## 🍗 CLI Options
| Option | Required | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--initialDocURLs` | Yes | set URL to start generating PDF from. |
| `--contentSelector` | Yes | used to find the part of main content |
| `--paginationSelector` | Yes | CSS Selector used to find next page to be printed for looping. |
| `--excludeURLs` | No | URLs to be excluded in PDF |
| `--excludeSelectors` | No | exclude selectors from PDF. Separate each selector **with comma and no space**. But you can use space in each selector. ex: `--excludeSelectors=".nav,.next > a"` |
| `--cssStyle` | No | CSS style to adjust PDF output ex: `--cssStyle="body{padding-top: 0;}"` \*If you're project owner you can use `@media print { }` to edit CSS for PDF. |
| `--outputPDFFilename` | No | name of the output PDF file. Default is `mr-pdf.pdf` |
| `--pdfMargin` | No | set margin around PDF file. Separate each margin **with comma and no space**. ex: `--pdfMargin="10,20,30,40"`. This sets margin `top: 10px, right: 20px, bottom: 30px, left: 40px` |
| `--pdfFormat` | No | pdf format ex: `--pdfFormat="A3"`. Please check this link for available formats [Puppeteer document](https://pptr.dev/#?product=Puppeteer&version=v5.2.1&show=api-pagepdfoptions) |
| `--disableTOC` | No | Optional toggle to show the table of contents or not |
| `--coverTitle` | No | Title for the PDF cover. |
| `--coverImage` | No | `` Image for PDF cover (does not support SVG) |
| `--coverSub` | No | Subtitle the for PDF cover. Add `
` tags for multiple lines. |
| `--headerTemplate` | No | HTML template for the print header. Please check this link for details of injecting values [Puppeteer document](https://pptr.dev/#?product=Puppeteer&show=api-pagepdfoptions) |
| `--footerTemplate` | No | HTML template for the print footer. Please check this link for details of injecting values [Puppeteer document](https://pptr.dev/#?product=Puppeteer&show=api-pagepdfoptions) |
| | | |
## 🎨 Examples and Demo PDF
### Docusaurus v1
`initialDocURLs`:
`demoPDF`:
`command`:
```shell
npx mr-pdf --initialDocURLs="https://docusaurus.io/docs/en/installation" --paginationSelector=".docs-prevnext > a.docs-next" --excludeSelectors=".fixedHeaderContainer,footer.nav-footer,#docsNav,nav.onPageNav,a.edit-page-link,div.docs-prevnext" --cssStyle=".navPusher {padding-top: 0;}" --pdfMargin="20"
```
### Docusaurus v2 beta
`initialDocURLs`:
`demoPDF`:
`command`:
```shell
npx mr-pdf --initialDocURLs="https://docusaurus.io/docs/" --contentSelector="article" --paginationSelector=".pagination-nav__item--next > a" --excludeSelectors=".margin-vert--xl a" --coverImage="https://docusaurus.io/img/docusaurus.png" --coverTitle="Docusaurus v2"
```
### Vuepress v1
`initialDocURLs`:
`demoPDF`:
`command`:
```shell
npx mr-pdf --initialDocURLs="https://vuepress.vuejs.org/guide/" --contentSelector="main" --paginationSelector=".page-nav .next a" --excludeSelectors="header.navbar,aside.sidebar,footer.page-edit .edit-link,.global-ui,.page-nav" --coverImage="https://vuepress.vuejs.org/hero.png" --coverTitle="VuePress" --coverSub="Vue-powered Static Site Generator"
```
### Vuepress v2 beta
`initialDocURLs`:
`demoPDF`:
`command`:
```shell
npx mr-pdf --initialDocURLs="https://v2.vuepress.vuejs.org/guide/" --contentSelector="main" --paginationSelector=".page-nav .next a" --excludeSelectors="header.navbar,aside.sidebar,footer.page-edit .edit-link,.global-ui,.page-nav" --coverImage="https://v2.vuepress.vuejs.org/images/hero.png" --coverTitle="VuePress" --coverSub="Vue-powered Static Site Generator"
```
### Mkdocs
`initialDocURLs`:
`demoPDF`:
`command`:
```shell
npx mr-pdf --initialDocURLs="https://www.mkdocs.org/" --paginationSelector="ul.navbar-nav li.nav-item a[rel~='next']" --excludeSelectors=".navbar.fixed-top,footer,.homepage .container .row .col-md-3,#toc-collapse" --cssStyle=".col-md-9 {flex: 0 0 100%; max-width: 100%;}"
```
### Material for Mkdocs
`initialDocURLs`:
`demoPDF`:
`command`:
```shell
npx mr-pdf --initialDocURLs="https://squidfunk.github.io/mkdocs-material/getting-started/" --paginationSelector="a.md-footer-nav__link--next" --excludeSelectors="header.md-header,.announce,nav.md-tabs,.md-main__inner .md-sidebar--primary,.md-main__inner .md-sidebar--secondary,footer" --cssStyle=".md-content {max-width: 100%!important;}"
```
#### PR to add new docs is welcome here... 😸
## 📄 How `mr-pdf` works
1. [puppter](https://pptr.dev/) can make html to PDF like you can print HTML page in chrome browser
2. so, the idea of mr-pdf is **generating one big HTML through looping page link, then run [`page.pdf()`](https://github.com/puppeteer/puppeteer/blob/v13.1.3/docs/api.md#pagepdfoptions)** from puppter to generate PDF.
## 🎉 Thanks
This repo's code is coming from .
Thanks for awesome code made by [@maxarndt](https://github.com/maxarndt) and [@aloisklink](https://github.com/aloisklink).
[@bojl](https://github.com/bojl) approach to make TOC was awesome and breakthrough.