Skip to content

Commit

Permalink
update readme with usage instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
EmilHvitfeldt committed Sep 6, 2023
1 parent 35bdc39 commit a098a0c
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,17 @@ quarto add emilhvitfeldt/quarto-revealjs-codewindow
This will install the extension under the `_extensions` subdirectory.
If you're using version control, you will want to check in this directory.

Once an extension has been added, you can use the Reveal plugin by adding it to the 1reveal-plugins` key. For example:

````` markdown
---
title: "My Presentation"
format: revealjs
revealjs-plugins:
- codewindow
---
`````

## Using

Adding a `::: {.codewindow}` fenced div around any code chunk will turn the output into a `codewindow`. The file tab is enabled by adding plain text before the code chunk.
Expand Down

0 comments on commit a098a0c

Please sign in to comment.