https://github.com/posit-dev/quarto-tiers
https://github.com/posit-dev/quarto-tiers
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/posit-dev/quarto-tiers
- Owner: posit-dev
- License: mit
- Created: 2023-11-03T22:07:51.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-11-14T18:12:43.000Z (7 months ago)
- Last Synced: 2026-03-04T10:00:23.820Z (4 months ago)
- Language: JavaScript
- Size: 450 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Quarto Tiers Extension For Quarto
`quarto-tiers` is an extension for Quarto to provide a shortcode to display
styled packaging tiers for Posit pro products.
## Installing
First, install the extension:
```bash
quarto add posit-dev/quarto-tiers@v4.0.1
```
## Using
The `{{< tier >}}` shortcode is available once the extension is installed
into your Quarto project.
The `{{< tier >}}` shortcode displays a badge using the
default styling for that tier. The three packaging tiers include: "Basic", "Enhanced",
and "Advanced". In addition, we've included several additional tiers to fulfill company needs, such as "Workbench", which receives Posit
maroon. The "Alternate" tier and any unassigned tiers use Posit gray.
```markdown
{{< tier Basic >}}
{{< tier Enhanced >}}
{{< tier Advanced >}}
{{< tier Workbench >}}
{{< tier Alternate >}}
```
Use `tier` shortcode anywhere outside headers; it is appropriate in call-outs,
tables, and inline text. Using the shortcode in a document header causes the
document table-of-contents to render poorly and is not recommended in that
context.
All badges are annotated with the `badge` and `rounded-pill` Bootstrap
classes. Each badge also receives one of the five CSS classes: `badge-basic`,
`badge-enhanced`, `badge-advanced`, `badge-wb`, and `badge-alt`, which define
tier-specific styles.
Additional CSS styles can be provided with the `style` parameter, which will be
added to the badge as inline CSS.
```markdown
{{< tier Basic style="font-style: italic;" >}}
```
## Configuration
The `quarto-tiers` YAML configuration can be used to provide optional titles
and URLs for each badge. When the `title` and `url` fields are present beneath
`quarto-tiers`, they provide default values for all product tier badges. Each
tier can override these choices by providing tier-named sub-configurations.
The `title` and `url` fields are optional.
```yaml
quarto-tiers:
title: "Default tier title."
url: "https://google.com/search?q=default+tier+url"
Enhanced:
title: "The default enhanced title."
Advanced:
url: "https://google.com/search?q=default+advanced+url"
```
Additionally, the short-code can supply `url` and `title`. These override any
values provided by the YAML. The `url` and `title` arguments are optional.
```markdown
{{< tier Basic url="https://example.com/" >}}
```
When a URL has been provided, the shortcode produces an `Tier` HTML
snippet. Without a URL, a `Tier` is emitted.
When a title has been provided, the `` or `` element is given a
`title="TITLE"` attribute.
## Example
Here is the source code for a minimal example: [example.qmd](example.qmd).