docs: ruby segment

This commit is contained in:
Jan De Dobbeleer 2021-02-04 08:38:20 +01:00 committed by Jan De Dobbeleer
parent 1ba666fe97
commit 07a258a47e
2 changed files with 33 additions and 0 deletions

32
docs/docs/segment-ruby.md Normal file
View file

@ -0,0 +1,32 @@
---
id: ruby
title: Ruby
sidebar_label: Ruby
---
## What
Display the currently active ruby version.
## Sample Configuration
```json
{
"type": "ruby",
"style": "powerline",
"powerline_symbol": "\uE0B0",
"foreground": "#ffffff",
"background": "#4063D8",
"properties": {
"prefix": " \uE791 "
}
}
```
## Properties
- display_version: `boolean` - display the ruby version - defaults to `true`
- missing_command_text: `string` - text to display when the command is missing - defaults to empty
- display_mode: `string` - determines when the segment is displayed
- `always`: the segment is always displayed
- `files`: the segment is only displayed when `*.rb`, `Gemfile` or `Rakefile` files are present (default)

View file

@ -25,6 +25,7 @@ module.exports = {
"path",
"python",
"root",
"ruby",
"session",
"shell",
"spotify",