diff options
| author | Charlotte Thomas <contact@nwa2coco.fr> | 2023-10-26 15:31:16 +0200 |
|---|---|---|
| committer | David Knaack <davidkna@users.noreply.github.com> | 2023-11-12 19:02:31 +0100 |
| commit | 7b217056bdb8dcb5b328b51fa3b68fe837f9fb3c (patch) | |
| tree | 6cf9bcad5d73f1a0706740b459115a1b5890b501 /docs/config/README.md | |
| parent | b5f9457b28db92406c03576663a6181a7081fd0f (diff) | |
feat: add typst module
Co-authored-by: David Knaack <davidkna@users.noreply.github.com>
Diffstat (limited to 'docs/config/README.md')
| -rw-r--r-- | docs/config/README.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index 55315d93c..e200115be 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -323,6 +323,7 @@ $scala\ $solidity\ $swift\ $terraform\ +$typst\ $vlang\ $vagrant\ $zig\ @@ -4278,6 +4279,39 @@ utc_time_offset = '-5' time_range = '10:00:00-14:00:00' ``` +## Typst + +The `typst` module shows the current installed version of Typst used in a project. + +By default, the module will be shown if any of the following conditions are met: + +- The current directory contains a `template.typ` file +- The current directory contains any `*.typ` 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` | `'t '` | A format string representing the symbol of Daml | +| `style` | `'bold #0093A7'` | The style for the module. | +| `detect_extensions` | `['.typ']` | Which extensions should trigger this module. | +| `detect_files` | `['template.typ']` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `disabled` | `false` | Disables the `daml` module. | + +### Variables + +| Variable | Example | Description | +| ------------- | --------- | ----------------------------------------------- | +| version | `v0.9.0` | The version of `typst`, alias for typst_version | +| typst_version | `default` | The current Typst version | +| 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 + ## Username The `username` module shows active user's username. |