Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
adamhsparks committed Aug 25, 2024
1 parent 4ceab3d commit 26b0667
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AAGI Extension For Quarto

A [quarto extension](https://quarto.org/docs/extensions/) currently featuring an AAGI theme for the [reveal.js format](https://quarto.org/docs/presentations/revealjs/).
A [quarto extension](https://quarto.org/docs/extensions/) currently featuring an AAGI theme LaTeX PDF documents and MS Word .docx files as well as a [reveal.js format](https://quarto.org/docs/presentations/revealjs/).

See the included [template.qmd](template.qmd) file for an example of the theme and integration into Quarto or explore the rendered version [here](http://AAGI-AUS.github.io/AAGIQuarto).

Expand All @@ -13,9 +13,18 @@ quarto use template AAGI-AUS/AAGIQuarto
```

This will install the extension and create an example qmd file that
you can use as a starting place for your presentation slides.
you can use as a starting place for your LaTeX PDF, MS Word .docx or reveal.js presentation slides.

## Using

For documentation on using Revealjs slides in Quarto, please see,
<https://quarto.org/docs/presentations/revealjs/>.
For documentation on using reveal.js slides in Quarto, please see,
<https://quarto.org/docs/presentations/revealjs/>.

## Updating

As we continue to improve this extension through bug fixes or adding new functionality, you can update it easily like so:

```bash
cd your_quarto_project_folder
quarto update AAGI-AUS/AAGIQuarto
```

0 comments on commit 26b0667

Please sign in to comment.