Skip to content

Commit

Permalink
Added mention to the new acronyms extension for Quarto
Browse files Browse the repository at this point in the history
Several Quarto users were interested in the Acronymsdown package,
but wanted to use it with Quarto rather than RMarkdown. While this
was already feasible (by copying and pasting the Lua files), this
was not an easy nor automated process. Providing a Quarto extension
makes it easier for these users, and will allow us to implement
new features targeting Quarto documents (such as shortcodes).

This commit closes #6.
  • Loading branch information
rchaput committed Jul 2, 2023
1 parent 638737e commit 3227434
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,14 @@ The package documentation can be found online at
https://rchaput.github.io/acronymsdown, or directly in your R console using
`vignette("acronymsdown")`.

:sparkles: [Quarto](https://quarto.org/) users should use the new extension
[acronyms](https://github.com/rchaput/acronyms) instead! :sparkles:
It has the same features as **Acronymsdown**, but packaged as a Quarto extension
for easier usage.
In the future, new features will be implemented **acronyms**; some will be
backported to **Acronymsdown**, but others (such as shortcodes) are too much
tied to Quarto.

## Features

- Tired of manually having to check whether the first occurrence of an
Expand Down
27 changes: 27 additions & 0 deletions vignettes/advanced_usage.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,33 @@ Please refer to the `rmarkdown` documentation for more details, in
particular `vignette("lua-filters", "rmarkdown")`, `?rmarkdown::output_format`,
and `?rmarkdown::pandoc_options`.

## Using acronymsdown with Quarto

A specific [Quarto extension](https://github.com/rchaput/acronyms) has been
developed for Quarto users. It contains all the features of **Acronymsdown**,
with an even easier usage!

Simply type the following command in your terminal to install the **acronyms**
Quarto extension:

```sh
quarto add rchaput/acronyms
```

Then, load the filter in your document metadata with:

```yaml
---
filters:
- acronyms
---
```

and start using acronyms in your document!

Please refer to the [documentation](https://rchaput.github.io/acronyms) for
detailed instructions.

## Using acronymsdown with only Pandoc / without RMarkdown

**acronymsdown** is implemented using a Pandoc [Lua Filter], whereas the R
Expand Down

0 comments on commit 3227434

Please sign in to comment.