diff --git a/docs/architecture.md b/docs/architecture.md index 2b354eb0..c061fb4e 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -13,7 +13,7 @@ The Gemini CLI is primarily composed of two main packages, along with a suite of - Input processing (parsing commands, text prompts). - History management. - Display rendering (including Markdown, code highlighting, and tool messages). - - Theme and UI customization. + - [Theme and UI customization](./cli/themes.md). - Communication with the Core package. - Manages user configuration settings specific to the CLI. diff --git a/docs/assets/theme-ansi-light.png b/docs/assets/theme-ansi-light.png new file mode 100644 index 00000000..9766ae78 Binary files /dev/null and b/docs/assets/theme-ansi-light.png differ diff --git a/docs/assets/theme-ansi.png b/docs/assets/theme-ansi.png new file mode 100644 index 00000000..5d46daca Binary files /dev/null and b/docs/assets/theme-ansi.png differ diff --git a/docs/assets/theme-atom-one.png b/docs/assets/theme-atom-one.png new file mode 100644 index 00000000..c2787d6b Binary files /dev/null and b/docs/assets/theme-atom-one.png differ diff --git a/docs/assets/theme-ayu-light.png b/docs/assets/theme-ayu-light.png new file mode 100644 index 00000000..f1774656 Binary files /dev/null and b/docs/assets/theme-ayu-light.png differ diff --git a/docs/assets/theme-ayu.png b/docs/assets/theme-ayu.png new file mode 100644 index 00000000..99391f82 Binary files /dev/null and b/docs/assets/theme-ayu.png differ diff --git a/docs/assets/theme-default-light.png b/docs/assets/theme-default-light.png new file mode 100644 index 00000000..829d4ed5 Binary files /dev/null and b/docs/assets/theme-default-light.png differ diff --git a/docs/assets/theme-default.png b/docs/assets/theme-default.png new file mode 100644 index 00000000..0b93a334 Binary files /dev/null and b/docs/assets/theme-default.png differ diff --git a/docs/assets/theme-dracula.png b/docs/assets/theme-dracula.png new file mode 100644 index 00000000..27213fbc Binary files /dev/null and b/docs/assets/theme-dracula.png differ diff --git a/docs/assets/theme-github-light.png b/docs/assets/theme-github-light.png new file mode 100644 index 00000000..3cdc94aa Binary files /dev/null and b/docs/assets/theme-github-light.png differ diff --git a/docs/assets/theme-github.png b/docs/assets/theme-github.png new file mode 100644 index 00000000..a62961b6 Binary files /dev/null and b/docs/assets/theme-github.png differ diff --git a/docs/assets/theme-google-light.png b/docs/assets/theme-google-light.png new file mode 100644 index 00000000..835ebc4b Binary files /dev/null and b/docs/assets/theme-google-light.png differ diff --git a/docs/assets/theme-xcode-light.png b/docs/assets/theme-xcode-light.png new file mode 100644 index 00000000..eb056a55 Binary files /dev/null and b/docs/assets/theme-xcode-light.png differ diff --git a/docs/cli/commands.md b/docs/cli/commands.md index 0da4802a..1792ce4c 100644 --- a/docs/cli/commands.md +++ b/docs/cli/commands.md @@ -16,7 +16,7 @@ Slash commands provide meta-level control over the CLI itself. They can typicall - **Description:** Clears the entire terminal screen, including the visible session history and scrollback within the CLI. - **Action:** Wipes the terminal display. The underlying session data (for history recall) might be preserved depending on the exact implementation, but the visual display is cleared. -- **`/theme`** +- [**`/theme`**](./themes.md) - **Description:** Allows you to change the visual theme of the Gemini CLI. - **Action:** Opens a dialog or prompt to select from available themes. diff --git a/docs/cli/index.md b/docs/cli/index.md index 5fd1c6fa..04657345 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -14,7 +14,7 @@ The Gemini CLI (`packages/cli`) is the primary way users interact with the Gemin - Syntax highlighting for code blocks in various languages. - Clear display of tool calls, inputs, and outputs. - **Command History:** Easily access and re-run previous commands and prompts. -- **Theming:** Customize the look and feel of the CLI to your preference. See the [Theming section in README.md](../../README.md#theming). +- **Theming:** Customize the look and feel of the CLI to your preference. See [Themes section](./themes.md). - **Configuration:** Tailor the CLI's behavior through configuration files. See [CLI Configuration](./configuration.md). - **Special Commands:** Utilize built-in commands for tasks like managing history, memory, or display. See [Commands](./commands.md). - **Enhanced Input:** Support for multiline input editing and readline-like keybindings for a more comfortable and efficient command entry experience. @@ -33,5 +33,6 @@ The Gemini CLI (`packages/cli`) is the primary way users interact with the Gemin - **[Commands](./commands.md):** A detailed reference for all built-in CLI commands (e.g., `/help`, `/history`, `/theme`). - **[Configuration](./configuration.md):** Understand how to configure various aspects of the CLI. +- **[Themes](./themes.md)**: A guide to customizing the CLI's appearance with different themes. This documentation will help you become proficient in using the Gemini CLI for a wide range of tasks. diff --git a/docs/cli/themes.md b/docs/cli/themes.md new file mode 100644 index 00000000..4eaabfc0 --- /dev/null +++ b/docs/cli/themes.md @@ -0,0 +1,55 @@ +# Themes + +The Gemini CLI supports a variety of themes to customize its appearance. You can change the theme to suit your preferences via the `/theme` command. Below are the available themes: + +## Dark Themes + +### ANSI + +ANSI theme + +### Atom OneDark + +Atom One theme + +### Ayu + +Ayu theme + +### Default + +Default theme + +### Dracula + +Dracula theme + +### GitHub + +GitHub theme + +## Light Themes + +### ANSI Light + +ANSI Light theme + +### Ayu Light + +Ayu Light theme + +### Default Light + +Default Light theme + +### GitHub Light + +GitHub Light theme + +### Google Code + +Google Code theme + +### Xcode + +Xcode Light theme