summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorfold-squirrel <90027154+fold-squirrel@users.noreply.github.com>2022-12-21 18:53:53 +0200
committerGitHub <noreply@github.com>2022-12-21 10:53:53 -0600
commite93dbf86301e19a89bd64997d95ba63a64f473aa (patch)
treef04d905d0a2171a770a81849e6a7697eda80131f /docs
parentc79e1d2be240a85494eb85b3edaf04ca662bcd33 (diff)
feat(fennel): add fennel module (#4717)
Diffstat (limited to 'docs')
-rw-r--r--docs/.vuepress/public/presets/toml/bracketed-segments.toml3
-rw-r--r--docs/.vuepress/public/presets/toml/no-empty-icons.toml3
-rw-r--r--docs/.vuepress/public/presets/toml/no-runtime-versions.toml3
-rw-r--r--docs/.vuepress/public/presets/toml/plain-text-symbols.toml3
-rw-r--r--docs/config/README.md40
5 files changed, 52 insertions, 0 deletions
diff --git a/docs/.vuepress/public/presets/toml/bracketed-segments.toml b/docs/.vuepress/public/presets/toml/bracketed-segments.toml
index c86ed0479..deaa6ae8c 100644
--- a/docs/.vuepress/public/presets/toml/bracketed-segments.toml
+++ b/docs/.vuepress/public/presets/toml/bracketed-segments.toml
@@ -46,6 +46,9 @@ format = '\[[$symbol($version)]($style)\]'
[erlang]
format = '\[[$symbol($version)]($style)\]'
+[fennel]
+format = '\[[$symbol($version)]($style)\]'
+
[gcloud]
format = '\[[$symbol$account(@$domain)(\($region\))]($style)\]'
diff --git a/docs/.vuepress/public/presets/toml/no-empty-icons.toml b/docs/.vuepress/public/presets/toml/no-empty-icons.toml
index 5b98fb7fb..eb94f1a31 100644
--- a/docs/.vuepress/public/presets/toml/no-empty-icons.toml
+++ b/docs/.vuepress/public/presets/toml/no-empty-icons.toml
@@ -37,6 +37,9 @@ format = '(via [$symbol($version )]($style))'
[erlang]
format = '(via [$symbol($version )]($style))'
+[fennel]
+format = '(via [$symbol($version )]($style))'
+
[golang]
format = '(via [$symbol($version )]($style))'
diff --git a/docs/.vuepress/public/presets/toml/no-runtime-versions.toml b/docs/.vuepress/public/presets/toml/no-runtime-versions.toml
index 97b6a3ed7..09accea7d 100644
--- a/docs/.vuepress/public/presets/toml/no-runtime-versions.toml
+++ b/docs/.vuepress/public/presets/toml/no-runtime-versions.toml
@@ -34,6 +34,9 @@ format = 'via [$symbol]($style)'
[erlang]
format = 'via [$symbol]($style)'
+[fennel]
+format = 'via [$symbol]($style)'
+
[golang]
format = 'via [$symbol]($style)'
diff --git a/docs/.vuepress/public/presets/toml/plain-text-symbols.toml b/docs/.vuepress/public/presets/toml/plain-text-symbols.toml
index 1efccd243..66eca654d 100644
--- a/docs/.vuepress/public/presets/toml/plain-text-symbols.toml
+++ b/docs/.vuepress/public/presets/toml/plain-text-symbols.toml
@@ -58,6 +58,9 @@ symbol = "exs "
[elm]
symbol = "elm "
+[fennel]
+symbol = "fnl "
+
[git_branch]
symbol = "git "
diff --git a/docs/config/README.md b/docs/config/README.md
index 5cd20bad1..904504b24 100644
--- a/docs/config/README.md
+++ b/docs/config/README.md
@@ -283,6 +283,7 @@ $dotnet\
$elixir\
$elm\
$erlang\
+$fennel\
$golang\
$guix_shell\
$haskell\
@@ -1475,6 +1476,45 @@ By default the module will be shown if any of the following conditions are met:
format = 'via [e $version](bold red) '
```
+## Fennel
+
+The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org).
+By default the module will be shown if any of the following conditions are met:
+
+- The current directory contains a file with the `.fnl` extension
+
+### 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` | `'🧅 '` | The symbol used before displaying the version of fennel. |
+| `style` | `'bold green'` | The style for the module. |
+| `detect_extensions` | `[fnl]` | Which extensions should trigger this module. |
+| `detect_files` | `[]` | Which filenames should trigger this module. |
+| `detect_folders` | `[]` | Which folders should trigger this modules. |
+| `disabled` | `false` | Disables the `fennel` module. |
+
+### Variables
+
+| Variable | Example | Description |
+| -------- | -------- | ------------------------------------ |
+| version | `v1.2.1` | The version of `fennel` |
+| 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
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[fennel]
+symbol = 'â«° '
+```
+
## Fill
The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are