Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
grantmcdermott committed May 8, 2023
1 parent 92b80bd commit 88371a7
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,28 @@
A minimal and elegant presentation theme for Quarto Reveal.js, inspired by Kyle's
[LaTex template](https://raw.githack.com/kylebutts/templates/master/latex-slides/auxiliary/slides.pdf).

Click the screenshot below to be taken to a [live demo](https://grantmcdermott.com/quarto-revealjs-clean-demo/template.html).
Click the screenshot below to be taken to a
[live demo](https://grantmcdermott.com/quarto-revealjs-clean-demo/template.html).

[![](clean-title.png "live demo")](https://grantmcdermott.com/quarto-revealjs-clean-demo/template.html)

## Use

Use the following [Quarto CLI](https://quarto.org/) command to install the theme.
Depending on your use-case, here are some [Quarto CLI](https://quarto.org/) to
get you started.

If you would like to add the **clean** theme to an existing directory:

```bash
quarto install extension grantmcdermott/quarto-revealjs-clean
```

Once the theme is installed, use one of the following templates for a quick start.
Alternatively, you can use a
[Quarto template](https://quarto.org/docs/extensions/starter-templates.html)
that bundles the **clean** theme plus a .qmd starter document. This is a better
option if you are starting a new project from scratch, since it will automatically
create a new directory with all of the necessary scaffolding in one go. We provide
two template options.

- Bare bones template

Expand Down

0 comments on commit 88371a7

Please sign in to comment.