https://github.com/juba/bookup-html

Bookup custom Quarto HTML format
https://github.com/juba/bookup-html

quarto

Last synced: about 1 month ago
JSON representation

Bookup custom Quarto HTML format

• Host: GitHub
• URL: https://github.com/juba/bookup-html
• Owner: juba
• License: mit
• Created: 2023-03-08T09:59:19.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-03T11:31:20.000Z (5 months ago)
• Last Synced: 2024-08-04T12:35:09.940Z (5 months ago)
• Topics: quarto
• Language: SCSS
• Homepage:
• Size: 4.66 MB
• Stars: 47
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# bookup-html custom quarto format

[![Publish examples](https://github.com/juba/bookup-html/actions/workflows/publish.yml/badge.svg)](https://github.com/juba/bookup-html/actions/workflows/publish.yml)

`bookup` is a custom [quarto](https://quarto.org) HTML format based on the Roboto font family. It provides both a light and a dark theme, and should be suitable for single documents, book projects and website projects.

## Screenshots

Single document, light theme
([live example](https://juba.github.io/bookup-html/bookup.html))

[![Single document light theme screenshot](screenshots/single_light.png)](https://juba.github.io/bookup-html/bookup.html)

Single document, dark theme
([live example](https://juba.github.io/bookup-html/bookup-dark.html))

[![Single document dark theme screenshot](screenshots/single_dark.png)](https://juba.github.io/bookup-html/bookup-dark.html)

Book project with a docked sidebar, light theme
([live example](https://juba.github.io/bookup-html/book/))

[![Book project screenshot](screenshots/book_light.png)](https://juba.github.io/bookup-html/book/)

Website project with a floating sidebar, dark theme
([live example](https://juba.github.io/bookup-html/website/))

[![Website project screenshot](screenshots/website_dark.png)](https://juba.github.io/bookup-html/website/)

## Installation and usage

To use this custom format, first install the extension at the root directory of your project:

```bash

quarto add juba/bookup-html

```

And add the format to your YAML configuration, along with other HTML format options if needed:

```yaml

format:

    bookup-html:

        toc: true

        toc-depth: 3

```

Even simpler, you can also directly install the extensions and generate a sample qmd file from a template with:

```bash

quarto use template juba/bookup-html

```

## Dark and light variants

**Warning :** this will only work with quarto version 1.3 or higher.

By default, your document will be displayed with the light theme, with a toggle allowing to switch to the dark theme.

If you want to change this behavior you can add a variant to the format name:

| Format name             | Theme used                                  |

| ----------------------- | ------------------------------------------- |

| `bookup-html` (default) | Light theme by default, optional dark theme |

| `bookup-html+dark`      | Dark theme by default, optional light theme |

| `bookup-html+lightonly` | Light theme only                            |

| `bookup-html+darkonly`  | Dark theme only                             |

## Format Options

Currently `bookup` provides the following option:

- `embed-fonts` : if set to `true`, fonts are included locally with the document. If set to `false`, they are downloaded from Google Web Fonts. Not that if you use `self-contained: true`, fonts are embedded inside the resulting HTML even if `embed-fonts` is `false`.

## Credits

This format is derived from the original [bookdown](https://bookdown.org) theme, adapted for the online french book [Introduction à R et au tidyverse](https://juba.github.io/tidyverse).