Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gadenbuie/quarto-partials
Partial content templates for Quarto
https://github.com/gadenbuie/quarto-partials
quarto quarto-extension quarto-shortcode
Last synced: 18 days ago
JSON representation
Partial content templates for Quarto
- Host: GitHub
- URL: https://github.com/gadenbuie/quarto-partials
- Owner: gadenbuie
- License: mit
- Created: 2024-07-24T20:19:40.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-07-25T14:39:50.000Z (4 months ago)
- Last Synced: 2024-10-14T22:31:14.466Z (about 1 month ago)
- Topics: quarto, quarto-extension, quarto-shortcode
- Language: Lua
- Homepage: http://pkg.garrickadenbuie.com/quarto-partials/
- Size: 15.6 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Partial content templates for Quarto
## Installing
``` bash
quarto add gadenbuie/quarto-partials
```
This will install the extension under the `_extensions` subdirectory. If
you’re using version control, you will want to check in this directory.
Once you’ve install the extension, you can use the
`{{< partial file ... >}}` shortcode to include partial content from
`file` in your [Quarto document](https://quarto.org)!
## Example
Use the `{{< partial file ... >}}` shortcode to include partial content
from `file` in your Quarto document. The partial content can use
[mustache templating syntax](https://mustache.github.io) and you can
provide named key-value pairs in the shortcode to provide the template
data.
For example, `_hello.md` contains the following content
**\_hello.md**
``` markdown
Hello, {{ name }}!
```
and we can include the partial, providing our own value for
`{{ name }}`:
> ``` markdown
> {{< partial _hello.md name="weary traveler" >}}
> ```
>
> Hello, weary traveler!
You can also include the partial data in the frontmatter of your
document, using the `partial-data` key, e.g.
``` yaml
partial-data:
name: "friend"
```
> ``` markdown
> {{< partial _hello.md >}}
>
> Or used inline: To you I say "{{< partial _hello.md >}}"
> ```
>
> Hello, !
>
> Or used inline: To you I say “Hello, !”
Alternatively, the second argument of the shortcode can point to a
custom key in your YAML frontmatter, e.g.
``` yaml
my-data:
friends:
name: amigo
```
> ``` markdown
> {{< partial _hello.md my-data.friends >}}
> ```
>
> Hello, !
Another, possibly less convenient, option is to provide JSON in the
shortcode data. Any key-value pair that starts with `{` or `[` will be
parsed into a JSON object or array.
Note that the file type affects the output. The next example, in
addition to using JSON data, uses a `.qmd` file to render the output as
Quarto-processed markdown.
**\_hello_first_last.qmd**
``` markdown
::: {.callout-tip title="Hi there!"}
{{#person}}
Hello, {{ honorific }} {{ name.first }} {{ name.last }}!
{{/person}}
:::
```
> ``` markdown
> {{< partial _hello_first_last.qmd person='{"honorific": "Mr.", "name": {"first": "Garrick", "last": "Aden-Buie"}}' >}}
> ```
>
> > [!TIP]
> >
> > ### Hi there!
> >
> > Hello, Mr. Garrick Aden-Buie!
Finally, remember that you can use the full power of [mustache
templating](https://mustache.github.io)! The next example creates a
markdown list from an array of my favorite fruits.
**\_favorite_fruits.md**
``` markdown
These are a few of my favorite fruits:
{{#fruits}}
- {{.}}
{{/fruits}}
```
> ``` markdown
> {{< partial _favorite_fruits.md fruits='["apple", "banana", "coconut", "mango"]' >}}
> ```
>
> These are a few of my favorite fruits:
>
> - apple
> - banana
> - coconut
> - mango
## Thanks!
`partials` embeds [lustache](https://github.com/Olivine-Labs/lustache),
a pure-Lua implementation of [mustache](https://mustache.github.io).
Thanks to the authors and contributors of these projects!
Thanks, as always, to the developers of [Quarto](https://quarto.org)!