-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a677da9
commit c663286
Showing
10 changed files
with
256 additions
and
361 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,89 +1,56 @@ | ||
| --- | ||
| title: Introduction | ||
| description: Welcome to Brook Code Theme! | ||
| title: Configuration | ||
| description: Customize Brook Code Theme to suit your coding style | ||
| publishedAt: 2024-12-19 | ||
| --- | ||
|
|
||
| Brook Code Theme is your ultimate companion for an elegant and productive coding experience. Designed with developers in mind, this theme brings a **clean**, **balanced**, and **visually appealing** look to your favorite code editors. | ||
| Brook code theme is highly configurable, allowing you to customize the theme to your liking. Here's a quick guide to get you started. | ||
|
|
||
| ## 🌟 Why Brook Code Theme? | ||
| ## Configuration Options | ||
|
|
||
| Brook Code Theme stands out by offering: | ||
| Brook Code Theme offers a wide range of customization options to suit your coding style and preferences. Here's a list of the most commonly used options: | ||
|
|
||
| - **Elegant Syntax Highlighting** | ||
| Say goodbye to cluttered code. Enjoy a balanced color palette that improves readability and keeps your focus intact during long coding sessions. | ||
| ### Color Scheme | ||
|
|
||
| - **Dark and Light Modes** | ||
| Switch effortlessly between dark and light themes to match your coding environment and preference. | ||
| The color scheme determines the overall look and feel of the theme. You can choose between a light or dark theme, or even create your own custom color scheme. The default color scheme is a soft pastel theme that provides a calming and relaxing atmosphere. | ||
|
|
||
| - **Multi-Editor Support** | ||
| Compatible with popular editors, including: | ||
| ### Syntax Highlighting | ||
|
|
||
| - **VSCode** | ||
| The syntax highlighting option allows you to choose the programming language you want to highlight. You can choose from a variety of languages, including JavaScript, TypeScript, Python, Go, Rust, HTML, and CSS. The default syntax highlighting is set to JavaScript. | ||
|
|
||
| - **JetBrains IDEs** | ||
| ### Theme Variant | ||
|
|
||
| - **Zed** | ||
| - And more! | ||
| The theme variant option allows you to choose between two different color schemes. The default variant is a subtle pastel theme that provides a soft and calming look. You can also choose a more vibrant and energetic variant, which is perfect for coding in a fast-paced environment. | ||
|
|
||
| - **Language Versatility** | ||
| Optimized for a wide range of programming languages, including: | ||
| - **JavaScript**, **TypeScript**, **Python**, **Go**, **Rust**, **HTML**, and **CSS**. | ||
| ### Editor Font | ||
|
|
||
| ## 🎨 Key Features | ||
| The editor font option allows you to choose the font you want to use in your code editor. You can choose from a variety of fonts, including monospace, sans-serif, and serif. The default font is a monospace font that provides a clean and professional look. | ||
|
|
||
| 1. **Aesthetic Design** | ||
| Enjoy a polished theme with carefully selected colors that are easy on the eyes. | ||
| ### Editor Font Size | ||
|
|
||
| 2. **Focus-Driven Color Palette** | ||
| Each color is chosen to emphasize the structure and syntax of your code, reducing cognitive load and improving productivity. | ||
| The editor font size option allows you to adjust the size of the font in your code editor. You can choose from a range of font sizes, including small, medium, and large. The default font size is set to medium. | ||
|
|
||
| 3. **Flexible Variants** | ||
| Choose between subtle pastel tones or vibrant colors to suit your coding style. | ||
| ### Editor Font Weight | ||
|
|
||
| 4. **Cross-Platform Compatibility** | ||
| Works seamlessly across multiple platforms and editors for a consistent experience. | ||
| The editor font weight option allows you to choose the weight of the font in your code editor. You can choose from a range of font weights, including light, regular, and bold. The default font weight is set to regular. | ||
|
|
||
| ## 🚀 Installation Guide | ||
| ### Editor Font Family | ||
|
|
||
| ### For VSCode | ||
| The editor font family option allows you to choose the font family of the font in your code editor. You can choose from a variety of font families, including monospace, sans-serif, and serif. The default font family is set to monospace. | ||
|
|
||
| 1. Open the Extensions Marketplace. | ||
| 2. Search for **Brook Code Theme**. | ||
| 3. Click "Install" and select the theme from your settings. | ||
| ### Editor Font Style | ||
|
|
||
| ### For JetBrains IDEs | ||
| The editor font style option allows you to choose the style of the font in your code editor. You can choose from a variety of font styles, including normal, italic, and oblique. The default font style is set to normal. | ||
|
|
||
| 1. Download the theme file from the official website (coming soon!). | ||
| 2. Import the theme in **Preferences > Appearance & Behavior > Themes**. | ||
| 3. Apply the theme and start coding. | ||
| ## Customizing the Theme | ||
|
|
||
| ### For Zed | ||
| Brook Code Theme is highly customizable, allowing you to tailor the theme to your liking. You can change the color scheme, syntax highlighting, theme variant, editor font, font size, font weight, font family, and font style. Here's how to customize the theme: | ||
|
|
||
| 1. Follow the Zed documentation for custom theme installation. | ||
| 2. Copy the Brook Code Theme configuration file. | ||
| 3. Activate the theme in Zed. | ||
| 1. Open the Brook Code Theme settings in your code editor. | ||
| 2. Navigate to the **Theme** section in the settings menu. | ||
| 3. Choose the color scheme, syntax highlighting, theme variant, editor font, font size, font weight, font family, and font style that you want to use. | ||
| 4. Save the changes and enjoy the customized theme! | ||
|
|
||
| ## 📸 Preview | ||
| ## Enjoy the Theme | ||
|
|
||
| Here’s a sneak peek of Brook Code Theme in action: | ||
|
|
||
| - **Dark Mode**: A moody, elegant theme with perfect contrast. | ||
| - **Light Mode**: Bright and vibrant for daylight coding sessions. | ||
|
|
||
| _Full previews and live demos will be available on our official website._ | ||
|
|
||
| ## ✨ Future Plans | ||
|
|
||
| Brook Code Theme is evolving! Here’s what’s next: | ||
|
|
||
| - **More Editor Support**: Expand compatibility to editors like Sublime Text and Atom. | ||
| - **Terminal Themes**: Matching themes for terminal applications like iTerm2 and Warp. | ||
| - **Customizable Options**: Tools to tweak the theme and make it truly yours. | ||
|
|
||
| Brook Code Theme is designed to enhance your coding experience, whether you're | ||
| building apps, writing scripts, or crafting web designs. | ||
|
|
||
| **Get ready to code in style. Let Brook Code Theme be your go-to choice for a seamless coding environment!** | ||
|
|
||
| Stay tuned for updates, or follow us on [GitHub](#) for the latest releases. | ||
| With the Brook Code Theme, you can customize the theme to your liking and create a unique coding experience. Happy coding! 🎨✨ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.