docs: Add a "Presets" page to the website (#783)

This commit is contained in:
Matan Kushner 2019-12-23 22:32:48 -05:00 committed by GitHub
parent e53ced8221
commit 3ddb7460a6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 1212 additions and 970 deletions

View File

@ -57,7 +57,8 @@ module.exports = {
["/guide/", "Guide"],
["/config/", "Configuration"],
["/advanced-config/", "Advanced Configuration"],
["/faq/", "Frequently Asked Questions"]
["/faq/", "Frequently Asked Questions"],
["/presets/", "Presets"]
]
},
"/ja-JP/": {

Binary file not shown.

Binary file not shown.

After

Width:  |  Height:  |  Size: 334 KiB

View File

@ -15,3 +15,12 @@
.hero
margin: 150px 25px 70px
@font-face
font-family: 'Nerd Font';
src: url("/nerd-font.woff2") format("woff2");
font-weight: 400;
font-style: normal
code
font-family: 'Nerd Font', source-code-pro, Menlo, Monaco, Consolas, "Courier New", monospace;

2101
docs/package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -4,8 +4,8 @@
"build": "vuepress build"
},
"devDependencies": {
"@vuepress/plugin-google-analytics": "^1.0.3",
"vuepress": "^1.0.2",
"vuepress-plugin-sitemap": "^2.3.0"
"@vuepress/plugin-google-analytics": "^1.2.0",
"vuepress": "^1.2.0",
"vuepress-plugin-sitemap": "^2.3.1"
}
}

63
docs/presets/README.md Normal file
View File

@ -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 = " "
```