Skip to content

Commit

Permalink
docs: ruby segment
Browse files Browse the repository at this point in the history
  • Loading branch information
JanDeDobbeleer committed Feb 4, 2021
1 parent 1ba666f commit 07a258a
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
32 changes: 32 additions & 0 deletions docs/docs/segment-ruby.md
@@ -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)
1 change: 1 addition & 0 deletions docs/sidebars.js
Expand Up @@ -25,6 +25,7 @@ module.exports = {
"path",
"python",
"root",
"ruby",
"session",
"shell",
"spotify",
Expand Down

0 comments on commit 07a258a

Please sign in to comment.