https://github.com/emilhvitfeldt/quarto-revealjs-highlightword

quarto Revealjs pluging for styled codechunks
https://github.com/emilhvitfeldt/quarto-revealjs-highlightword

quarto quarto-extension quartopub revealjs

Last synced: 3 months ago
JSON representation

quarto Revealjs pluging for styled codechunks

• Host: GitHub
• URL: https://github.com/emilhvitfeldt/quarto-revealjs-highlightword
• Owner: EmilHvitfeldt
• Created: 2023-09-06T18:27:47.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-12T21:19:03.000Z (over 1 year ago)
• Last Synced: 2024-05-08T08:32:49.878Z (9 months ago)
• Topics: quarto, quarto-extension, quartopub, revealjs
• Language: JavaScript
• Homepage: https://emilhvitfeldt.github.io/quarto-revealjs-highlightword/
• Size: 3.1 MB
• Stars: 12
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# highlightword Extension For Quarto

Revealjs plugin to highlight specific parts of code.

![](example.gif)

I don't intend to add more functionality to this project other than fixing bugs. 

There is a need for a more general highlighting plugin that works across multiple words (this plugin doesn't allow you to highlight two parts of code that is styled differently by the highligter.) 

## Installing

```bash

quarto add emilhvitfeldt/quarto-revealjs-highlightword

```

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 `reveal-plugins` key. For example:

````` markdown

---

title: "My Presentation"

format: revealjs

revealjs-plugins:

  - highlightword

---

`````

## Using

Adding a fenced with with `.fragment .highlightword` and the `word` you need, plus what any valid CSS `style` you want applied. Additional arguments `number` and `chunk` changes which match should be highlighted. See examples for more detail.

## Example

Here is the source code for a minimal example: [example.qmd](example.qmd).