Skip to content

Enhance README.md #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sweep-ai-deprecated wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Enhance README.md #4

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
217f1cb
feat: Updated README.md
sweep-ai-deprecated[bot] Oct 9, 2023
2b5e15d
feat: Updated README.md
sweep-ai-deprecated[bot] Oct 9, 2023
cd83642
feat: Updated README.md
sweep-ai-deprecated[bot] Oct 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 39 additions & 42 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<h1 align="center">Poly highlights - JetBrains' custom theme.</h1>

<p align="center">
<i>Luminance-corrected (LCH) highlighting for JetBrains IDEs. Updated regularly.</i>
<i>Poly highlights is a luminance-corrected (LCH) highlighting theme for JetBrains IDEs. It was created to enhance the readability and aesthetics of your code, making it easier to navigate and understand. Whether you're a seasoned developer or a beginner, Poly highlights is designed to improve your coding experience. Updated regularly.</i>
<br>
<a href="./INSTALLATION.md">How to install.</a>
<b>Installation:</b> To install Poly highlights, navigate to your IDE's settings and select the Poly highlights theme. For more detailed instructions, see the <a href="./INSTALLATION.md">installation guide</a>.
</p>

<p align="center">
Expand All @@ -12,61 +12,58 @@

</p>


Hand crafted for clarity and focus. Using luminance-corrected colors for maximum confort.
Hand crafted for clarity and focus. Using luminance-corrected colors for maximum confort.

Language defaults correctly applied, so you can extend it as you please

Just use https://github.com/fabrizioschiavi/pragmatapro or https://github.com/be5invis/Iosevka if you prefer condensed fonts.
___
Supported and tested languages:

- Typescript
- Angular (language service)
- Javascript
- HTML
- CSS
- SCSS
- SASS
- Java
- Kotlin
- C#
- .NET

# Design strategy

These have been generated in a LCH colorspace and then manually adjusted for their derivative colors.
| What | Color | Hex | Why |
|---------------- |-------- |-------- |----------------------------------------------- |
| Keyword | Blue | #4BA5FF | Base color |
| Class | Green | #70B844 | Easy to locate |
| Interface | Purple | #D28BD7 | Easy to locate |
| Variable/Field | Orange | #EB8443 | Less fatiguing color against dark backgrounds |
| Parameter | Yellow | #FFCA28 | Contrast with method body |
| String | White | #C3CEE3 | Contrast, neutral color |
---

# Samples
Typescript|HTML|
:-------------------------:|:-------------------------:
![image](https://user-images.githubusercontent.com/16295552/115997891-1b5b6380-a5e5-11eb-9061-2c2c6e4c9361.png) | ![image](https://user-images.githubusercontent.com/16295552/115997907-27472580-a5e5-11eb-8bc3-210fd8cd122f.png)
Supported and tested languages:

- Typescript: Poly highlights improves Typescript code readability by distinctly highlighting key elements.
- Angular (language service): Poly highlights improves navigation and understanding of Angular templates.
- Javascript: Poly highlights improves Javascript code comprehension by distinctly highlighting syntax and keywords.
- HTML: Poly highlights improves HTML code readability by distinctly highlighting tags and attributes.
- CSS, SCSS, SASS: Poly highlights improves CSS, SCSS, and SASS code readability by distinctly highlighting selectors, properties, and values.
- Java: Poly highlights enhances Java code comprehension by distinctly highlighting classes, methods, and variables.
- Kotlin: Poly highlights improves navigation and understanding of Kotlin code.
- C#, .NET: Poly highlights improves C# and .NET code comprehension by distinctly highlighting key elements.

SCSS|JSON|
:-------------------------:|:-------------------------:
![image](https://user-images.githubusercontent.com/16295552/117311867-e4a70800-ae84-11eb-8ddd-480b8061aa31.png) | ![image](https://user-images.githubusercontent.com/16295552/117311318-6185b200-ae84-11eb-931b-cda5da5dfb38.png)
# Design strategy

These have been generated in a LCH colorspace and then manually adjusted for their derivative colors. The colors were chosen to maximize contrast and readability, while also being easy on the eyes. Here's a breakdown of the color choices:

JS|TS|
:-------------------------:|:-------------------------:
![image](https://user-images.githubusercontent.com/16295552/117312275-3485cf00-ae85-11eb-9a97-9aa42d3251db.png) | ![image](https://user-images.githubusercontent.com/16295552/117312633-7a429780-ae85-11eb-8eaa-eaea46b571a1.png)
| What | Color | Hex | Why |
| -------------- | ------ | ------- | ----------------------------------------------------------------------------- |
| Keyword | Blue | #4BA5FF | Base color, designed for clear distinction |
| Class | Green | #70B844 | Prominent against other elements, facilitating quick location |
| Interface | Purple | #D28BD7 | Distinct from classes, aiding in quick identification |
| Variable/Field | Orange | #EB8443 | Less fatiguing color against dark backgrounds, designed for clear distinction |
| Parameter | Yellow | #FFCA28 | Contrasts with method body, facilitating quick location |
| String | White | #C3CEE3 | Contrast, neutral color, easy to read |

# Samples

The following samples showcase how Poly highlights works with different languages and IDEs. Each color represents a different element of the code, making it easier to read and understand.

Angular Templates|.NET|
:-------------------------:|:-------------------------:
![image](https://user-images.githubusercontent.com/16295552/117312936-bd9d0600-ae85-11eb-8c97-416c00768e38.png)| ![image](https://user-images.githubusercontent.com/16295552/117313304-0fde2700-ae86-11eb-91c9-076147b5acbd.png)
| Typescript | HTML |
| :-------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------: |
| ![image](https://user-images.githubusercontent.com/16295552/115997891-1b5b6380-a5e5-11eb-9061-2c2c6e4c9361.png) | ![image](https://user-images.githubusercontent.com/16295552/115997907-27472580-a5e5-11eb-8bc3-210fd8cd122f.png) |

| SCSS | JSON |
| :-------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------: |
| ![image](https://user-images.githubusercontent.com/16295552/117311867-e4a70800-ae84-11eb-8ddd-480b8061aa31.png) | ![image](https://user-images.githubusercontent.com/16295552/117311318-6185b200-ae84-11eb-931b-cda5da5dfb38.png) |

| JS | TS |
| :-------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------: |
| ![image](https://user-images.githubusercontent.com/16295552/117312275-3485cf00-ae85-11eb-9a97-9aa42d3251db.png) | ![image](https://user-images.githubusercontent.com/16295552/117312633-7a429780-ae85-11eb-8eaa-eaea46b571a1.png) |

| Angular Templates | .NET |
| :-------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------: |
| ![image](https://user-images.githubusercontent.com/16295552/117312936-bd9d0600-ae85-11eb-8c97-416c00768e38.png) | ![image](https://user-images.githubusercontent.com/16295552/117313304-0fde2700-ae86-11eb-91c9-076147b5acbd.png) |

# Contributing

We welcome contributions to Poly highlights! If you have a suggestion, bug report, or want to add a new feature, please open an issue or submit a pull request. For more information, see the [contributing guide](./CONTRIBUTING.md).