summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorwhi-tw <tom@whi.tw>2021-02-22 20:10:36 +0000
committerGitHub <noreply@github.com>2021-02-22 14:10:36 -0600
commit4d3a4f230d5f38b75e667ee82a4fc6a3c6cf97dc (patch)
tree018199ce11863a2a5d933427aebeea688f1fd84a /docs
parent28170f62b07ff94b87908f52fbac942dc7653c8c (diff)
fix(nodejs): Change symbol to nerd-font (#1649)
The unicode hexagon symbol does not actually fit into a single column with a fixed-width font.  does. As starship requires a nerd font as a prerequisite, it's safe to assume that this symbol is available. Symbol link: https://www.nerdfonts.com/cheat-sheet?set=nf-mdi-nodejs In the documentation, I've left the '⬢' symbols in '#### Text Group' as they are, as they will continue displaying correctly in a browser without a nerd font available. I feel like readability is more important than consistency with the new nodejs symbol, especially as this documentation section does not actually refer to nodejs, rather it's just a symbol. As `⬢` has been replaced, use `⌘` instead in documentation to avoid any possible confusion
Diffstat (limited to 'docs')
-rw-r--r--docs/config/README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/config/README.md b/docs/config/README.md
index 784eea70f..62a20d737 100644
--- a/docs/config/README.md
+++ b/docs/config/README.md
@@ -85,7 +85,7 @@ In the second part, which is enclosed in a `()`, is a [style string](#style-stri
For example:
- `[on](red bold)` will print a string `on` with bold text colored red.
-- `[⬢ $version](bold green)` will print a symbol `⬢ ` followed by the content of variable `version`, with bold text colored green.
+- `[⌘ $version](bold green)` will print a symbol `⌘ ` followed by the content of variable `version`, with bold text colored green.
- `[a [b](red) c](green)` will print `a b c` with `b` red, and `a` and `c` green.
#### Style Strings
@@ -1814,7 +1814,7 @@ By default the module will be shown if any of the following conditions are met:
| Option | Default | Description |
| ------------------- | ------------------------------------ | -------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
-| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. |
+| `symbol` | `" "` | A format string representing the symbol of NodeJS. |
| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this moudle. |
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |