https://github.com/nrennie/prettypaged

Quarto extension to generate a paged HTML document with (pretty) Paged.js styling.
https://github.com/nrennie/prettypaged

pagedjs quarto quarto-extension quarto-template

Last synced: 18 days ago
JSON representation

Quarto extension to generate a paged HTML document with (pretty) Paged.js styling.

• Host: GitHub
• URL: https://github.com/nrennie/prettypaged
• Owner: nrennie
• License: cc0-1.0
• Created: 2024-07-26T18:27:40.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-07-27T00:41:34.000Z (4 months ago)
• Last Synced: 2024-07-28T00:38:25.162Z (4 months ago)
• Topics: pagedjs, quarto, quarto-extension, quarto-template
• Language: CSS
• Homepage:
• Size: 1.18 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: NEWS.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# PrettyPaged

> [!WARNING]

> This extension is a work in progress - it's not ready for testing yet!

Quarto extension for a template to generate a PDF from a paged HTML document with (pretty) styling using Paged.js. Use `PrettyPaged-pdf` for the format. See [github.com/nrennie/PrettyPDF](https://github.com/nrennie/PrettyPDF) for the LaTeX version of this template and [github.com/nrennie/PrettyTypst](https://github.com/nrennie/PrettyTypst) for the Typst version of this template.

## Installation and use

### Paged.js installation

To use this extension, you must have [Paged.js](https://pagedjs.org/) installed on your system. See the **Command line version** section of [pagedjs.org/documentation/2-getting-started-with-paged.js](https://pagedjs.org/documentation/2-getting-started-with-paged.js/) for instructions.

> [!WARNING]

> There are still some issues with getting `pagedjs-cli` to work with pandoc on Windows. See [#8946](https://github.com/quarto-dev/quarto-cli/issues/8946) and [#8061](https://github.com/jgm/pandoc/issues/8061). A workaround is to render the Quarto document using `format: PrettyPaged-html` and then in the command line run `pagedjs-cli -i template.html -o template.pdf` to convert from HTML to PDF.

### Quarto extension installation

To install the Quarto extension, create a directory, and use the template file:

``` bash

quarto use template nrennie/PrettyPaged

```

To use the extension in an existing project without installing the template file:

``` bash

quarto install extension nrennie/PrettyPaged

```

Note that you will need to update the output format to `format: PrettyPaged-pdf` to enable use of the extension. For book projects, add:

```

project:

  type: PrettyPaged

```

to the `_quarto.yml` file.