From 07a258a47e5bfa812860b6b23984786751b644fd Mon Sep 17 00:00:00 2001 From: Jan De Dobbeleer <jan.de.dobbeleer@gmail.com> Date: Thu, 4 Feb 2021 08:38:20 +0100 Subject: [PATCH] docs: ruby segment --- docs/docs/segment-ruby.md | 32 ++++++++++++++++++++++++++++++++ docs/sidebars.js | 1 + 2 files changed, 33 insertions(+) create mode 100644 docs/docs/segment-ruby.md diff --git a/docs/docs/segment-ruby.md b/docs/docs/segment-ruby.md new file mode 100644 index 00000000..32a32de8 --- /dev/null +++ b/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) diff --git a/docs/sidebars.js b/docs/sidebars.js index 62248de4..ca70ed36 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -25,6 +25,7 @@ module.exports = { "path", "python", "root", + "ruby", "session", "shell", "spotify",