summaryrefslogtreecommitdiffstats
path: root/docs/presets
diff options
context:
space:
mode:
authorMatan Kushner <hello@matchai.me>2019-12-23 22:32:48 -0500
committerGitHub <noreply@github.com>2019-12-23 22:32:48 -0500
commit3ddb7460a62efd29d9f54dda07f0582349441fca (patch)
tree07d25d4c467ebfdba522d9d00668ea8f18a3b6c8 /docs/presets
parente53ced82216479a7d7137604af55f5d71c51a84a (diff)
docs: Add a "Presets" page to the website (#783)
Diffstat (limited to 'docs/presets')
-rw-r--r--docs/presets/README.md63
1 files changed, 63 insertions, 0 deletions
diff --git a/docs/presets/README.md b/docs/presets/README.md
new file mode 100644
index 000000000..e7608a190
--- /dev/null
+++ b/docs/presets/README.md
@@ -0,0 +1,63 @@
+# Presets
+
+Here is a collection of community-submitted configuration presets for Starship.
+If you have a preset to share, please [submit a PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) updating this file! 😊
+
+## Nerd Font Symbols
+
+This preset doesn't change anything except for the symbols used for each module.
+If emojis aren't your thing, this might catch your eye!
+
+![Screenshot of Nerd Font Symbols preset](/presets/nerd-font-symbols.png)
+
+### Prerequisites
+
+- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Fira Code Nerd Font)
+
+### Configuration
+
+```toml
+[aws]
+symbol = " "
+
+[battery]
+full_symbol = ""
+charging_symbol = ""
+discharging_symbol = ""
+
+[conda]
+symbol = " "
+
+[git_branch]
+symbol = " "
+
+[golang]
+symbol = " "
+
+[hg_branch]
+symbol = " "
+
+[java]
+symbol = " "
+
+[memory_usage]
+symbol = " "
+
+[nodejs]
+symbol = " "
+
+[package]
+symbol = " "
+
+[php]
+symbol = " "
+
+[python]
+symbol = " "
+
+[ruby]
+symbol = " "
+
+[rust]
+symbol = " "
+```