diff options
| author | Virgile Andreani <armavica@ulminfo.fr> | 2024-03-20 17:50:12 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-03-20 22:50:12 +0100 |
| commit | 0e49f04a6b249090cf3703c5dac041a51e6bf530 (patch) | |
| tree | 9807d68b5a52c3a35465a02c80a591c979d1c240 /docs/config/README.md | |
| parent | d879317d513282e62d57347275911be042ee230d (diff) | |
feat(quarto): Add Quarto module (#5820)
Add Quarto module
* Adapted from the Typst module
Diffstat (limited to 'docs/config/README.md')
| -rw-r--r-- | docs/config/README.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index 34beb729d..213439514 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -314,6 +314,7 @@ $php\ $pulumi\ $purescript\ $python\ +$quarto\ $raku\ $rlang\ $red\ @@ -3590,6 +3591,38 @@ python_binary = 'python3' detect_extensions = [] ``` +## Quarto + +The `quarto` module shows the current installed version of Quarto used in a project. + +By default, the module will be shown if any of the following conditions are met: + +- The current directory contains a `_quarto.yml` file +- The current directory contains any `*.qmd` file + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'⨁ '` | A format string representing the symbol of Quarto | +| `style` | `'bold #75AADB'` | The style for the module. | +| `detect_extensions` | `['.qmd']` | Which extensions should trigger this module. | +| `detect_files` | `['_quarto.yml']` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `disabled` | `false` | Disables the `quarto` module. | + +### Variables + +| Variable | Example | Description | +| -------- | --------- | ------------------------------------ | +| version | `1.4.549` | The version of `quarto` | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + ## R The `rlang` module shows the currently installed version of [R](https://www.r-project.org/). The module will be shown if |