https://github.com/pharmar/rvalhub-quarto
A quarto theme for R Validation Hub slides
https://github.com/pharmar/rvalhub-quarto
extension quarto r rvalhub theme
Last synced: 7 months ago
JSON representation
A quarto theme for R Validation Hub slides
- Host: GitHub
- URL: https://github.com/pharmar/rvalhub-quarto
- Owner: pharmaR
- Created: 2023-06-26T22:23:42.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-07T20:27:44.000Z (about 2 years ago)
- Last Synced: 2024-06-07T23:48:08.612Z (about 2 years ago)
- Topics: extension, quarto, r, rvalhub, theme
- Language: SCSS
- Homepage: https://pharmar.github.io/rvalhub-quarto/
- Size: 4.35 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# R Validation Hub `quarto` Theme
[_view an example slidedeck in your browser_](https://pharmar.github.io/rvalhub-quarto)
[preview.webm](https://github.com/pharmaR/rvalhub-quarto/assets/18220321/cfc056b1-a0d2-411b-be87-aa81f4fdae30)
`format: rvalhub-revealjs+light` (or default alias, `rvalhub-revealjs`)
`format: rvalhub-revealjs+dark`
## Getting Started
### Installing
After creating your new quarto presentation, you can add the R Validation Hub
theme by following a simple installation process:
```bash
quarto install extension pharmaR/rvalhub-quarto
```
alternatively install from an archive url
```bash
quarto install extension https://github.com/pharmaR/rvalhub-quarto/archive/refs/heads/main.zip
```
After installing, your project should contain a `_extensions/pharmaR/rvalhub` directory.
> ***Note: GitHub Organization Case Sensitivity***
> Although `quarto` will gladly install the extension using a case-insensitive
> GitHub org, assets used throughout the extension will use case-sensitive file paths.
> Be sure to use the appropriate casing.
### Using
After you've installed the extension, you need to use one of the provided
formats. This can be provided either in your `_quarto.yml` file or in the front
matter of a standalone `quarto` document.
**_quarto.yml**
```
format: rvalhub-revealjs
```
As well as the provided default, you can specify either a light or dark theme
using the format variants, `rvalhub-revealjs+light` and `rvalhub-revealjs+dark`.
## Example
Here is the source code for a minimal sample document: [example.qmd](example.qmd).
After cloning this repo, you can test it out by running
```
quarto preview example.qmd
```
## Starting a new `quarto` project
### Using `quarto` from the command line
1. Create a new `quarto` project
```
quarto create # follow prompts to start a default project
```
> _change to new project directory_
2. Add `quarto` format extension
```
quarto install extension pharmaR/rvalhub-quarto
```
3. Update your `_quarto.yml` file
```diff
+ format: rvalhub-revealjs
```
or use the dark variant by using:
```diff
+ format: rvalhub-revealjs+dark
```