Code Monkey home page Code Monkey logo

bookup-html's Introduction

bookup-html custom quarto format

Publish examples

bookup is a custom quarto 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)

Single document light theme screenshot

Single document, dark theme
(live example)

Single document dark theme screenshot

Book project with a docked sidebar, light theme
(live example)

Book project screenshot

Website project with a floating sidebar, dark theme
(live example)

Website project screenshot

Installation and usage

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

quarto add juba/bookup-html

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

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:

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 theme, adapted for the online french book Introduction ร  R et au tidyverse.

bookup-html's People

Contributors

juba avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.