{"id":13790600,"url":"https://github.com/juba/bookup-html","last_synced_at":"2025-07-17T21:34:01.356Z","repository":{"id":137876463,"uuid":"611188763","full_name":"juba/bookup-html","owner":"juba","description":"Bookup custom Quarto HTML format","archived":false,"fork":false,"pushed_at":"2024-08-03T11:31:20.000Z","size":4889,"stargazers_count":53,"open_issues_count":0,"forks_count":5,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-15T00:46:02.704Z","etag":null,"topics":["quarto"],"latest_commit_sha":null,"homepage":"","language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/juba.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-08T09:59:19.000Z","updated_at":"2025-02-08T10:31:08.000Z","dependencies_parsed_at":"2024-08-03T12:32:12.985Z","dependency_job_id":"c6762ec7-aa33-4b89-be74-0621f89e7919","html_url":"https://github.com/juba/bookup-html","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juba%2Fbookup-html","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juba%2Fbookup-html/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juba%2Fbookup-html/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juba%2Fbookup-html/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/juba","download_url":"https://codeload.github.com/juba/bookup-html/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244856069,"owners_count":20521755,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["quarto"],"created_at":"2024-08-03T22:00:47.724Z","updated_at":"2025-03-21T19:36:25.022Z","avatar_url":"https://github.com/juba.png","language":"SCSS","funding_links":[],"categories":["Templates"],"sub_categories":["HTML Documents"],"readme":"# bookup-html custom quarto format\n\n[![Publish examples](https://github.com/juba/bookup-html/actions/workflows/publish.yml/badge.svg)](https://github.com/juba/bookup-html/actions/workflows/publish.yml)\n\n\n`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.\n\n## Screenshots\n\n\u003ctable\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\n\nSingle document, light theme\u003cbr\u003e([live example](https://juba.github.io/bookup-html/bookup.html))\n\n\u003c/td\u003e\n\u003ctd\u003e\n\n[![Single document light theme screenshot](screenshots/single_light.png)](https://juba.github.io/bookup-html/bookup.html)\n\n\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\n\nSingle document, dark theme\u003cbr\u003e([live example](https://juba.github.io/bookup-html/bookup-dark.html))\n\n\u003c/td\u003e\n\u003ctd\u003e\n\n[![Single document dark theme screenshot](screenshots/single_dark.png)](https://juba.github.io/bookup-html/bookup-dark.html)\n\n\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\n\nBook project with a docked sidebar, light theme\u003cbr\u003e([live example](https://juba.github.io/bookup-html/book/))\n\n\u003c/td\u003e\n\u003ctd\u003e\n\n[![Book project screenshot](screenshots/book_light.png)](https://juba.github.io/bookup-html/book/)\n\n\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\n\nWebsite project with a floating sidebar, dark theme\u003cbr\u003e([live example](https://juba.github.io/bookup-html/website/))\n\n\u003c/td\u003e\n\u003ctd\u003e\n\n[![Website project screenshot](screenshots/website_dark.png)](https://juba.github.io/bookup-html/website/)\n\n\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\n## Installation and usage\n\nTo use this custom format, first install the extension at the root directory of your project:\n\n```bash\nquarto add juba/bookup-html\n```\n\nAnd add the format to your YAML configuration, along with other HTML format options if needed:\n\n```yaml\nformat:\n    bookup-html:\n        toc: true\n        toc-depth: 3\n```\n\n\nEven simpler, you can also directly install the extensions and generate a sample qmd file from a template with:\n\n```bash\nquarto use template juba/bookup-html\n```\n\n## Dark and light variants\n\n**Warning :** this will only work with quarto version 1.3 or higher.\n\nBy default, your document will be displayed with the light theme, with a toggle allowing to switch to the dark theme.\n\nIf you want to change this behavior you can add a variant to the format name:\n\n| Format name             | Theme used                                  |\n| ----------------------- | ------------------------------------------- |\n| `bookup-html` (default) | Light theme by default, optional dark theme |\n| `bookup-html+dark`      | Dark theme by default, optional light theme |\n| `bookup-html+lightonly` | Light theme only                            |\n| `bookup-html+darkonly`  | Dark theme only                             |\n\n\n## Format Options\n\n\nCurrently `bookup` provides the following option:\n\n- `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`.\n\n\n## Credits\n\nThis 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).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuba%2Fbookup-html","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjuba%2Fbookup-html","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuba%2Fbookup-html/lists"}