generated from quarto-journals/article-format-template
-
Notifications
You must be signed in to change notification settings - Fork 3
/
README.Rmd
45 lines (29 loc) · 1.47 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
---
output: github_document
---
# Macquarie University Quarto reveal.js Presentation Template <img src="https://user-images.githubusercontent.com/15133161/200966938-ba6f8413-fa77-4ccb-b16d-d7cf14926057.png" align ="right" alt="" width ="150"/>
> Template for creating a new reveal.js article format for Quarto.
>
> See information about how-to use this repo template inside the template file.
This is a Quarto template that assists you in creating a presentation for use with Macquarie University branding. You can learn more about about Quarto using the official guide <https://quarto.org/docs/guide/>.
## Creating a New Presentation
You can use this as a template to create a reveal.js presentation with a Macquarie University theme. To do this, use the following command in your Terminal:
```bash
quarto use template thomas-fung/quarto-mq-revealjs-theme
```
This will install the extension and create an example qmd file that you can use as a starting place for your presentation.
## Installation For Existing Document
You may also use this format with an existing Quarto project or presentation. From the quarto project or presentation directory, run the following command in your Terminal to install this format:
```bash
quarto install extension thomas-fung/quarto-mq-revealjs-theme
```
## Usage
To use the format, you can use the format name `mq-revealjs`. For example:
```bash
quarto render article.qmd --to mq-revealjs
```
or in your document yaml
```yaml
format:
mq-revealjs
```