Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
RodrigoLuglio committed Sep 21, 2024
1 parent 19a2565 commit 93263d7
Showing 1 changed file with 47 additions and 38 deletions.
85 changes: 47 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
# 🎨 VSCode Theme Generator

Generate stunning, customized VSCode themes with our intelligent color algorithm and semantic token system.
Generate stunning, customized VSCode themes with our intelligent color algorithm, sacred geometry patterns, and semantic token system.

## ✨ Features

- 🖌️ Intelligent color generation algorithm
- 🔯 Sacred geometry-inspired color schemes
- 🧠 Semantic token support for enhanced syntax highlighting
- 🎭 Light and dark theme variants
- 🔧 Customizable color palettes
- 📦 Easy export to VSCode extension format
- 🔒 Color locking for fine-tuned control
- 🔄 ANSI color regeneration
- 🖥️ Live theme preview with Monaco editor

## 🧬 Color Generation Algorithm

Expand All @@ -19,43 +23,46 @@ Our algorithm creates harmonious color schemes by:
3. Adjusting saturation and brightness for optimal contrast
4. Applying color theory principles for visual appeal

## 🔯 Sacred Geometry Color Schemes

One of our standout features is the use of sacred geometry patterns to create visually stunning and harmonious color schemes. These patterns, derived from ancient mathematical principles, include:

- Flower of Life
- Fibonacci Spiral
- Golden Ratio
- Platonic Solids
- Sri Yantra

Each pattern is used to generate a unique color palette that resonates with the underlying mathematical harmony found in nature. This approach ensures that your themes are not only aesthetically pleasing but also grounded in timeless design principles.

### How it works:

1. Select a sacred geometry pattern
2. The algorithm maps colors to specific points or sections of the pattern
3. Color relationships are determined based on their positions within the pattern
4. The resulting palette is applied to your VSCode theme

This feature allows for the creation of themes that are both visually appealing and conceptually meaningful.

## 🏷️ Semantic Tokens

We use semantic tokens to provide consistent and meaningful syntax highlighting:

- `keyword`: Language keywords
- `string`: String literals
- `comment`: Comments
- `function`: Function declarations and calls
- `variable`: Local variables
- `type`: Type annotations
- `constant`: Constant values
- `class`: Class declarations
- `number`: Numeric literals
- `operator`: Operators
- `parameter`: Function parameters
- `property`: Object properties
- `punctuation`: Punctuation marks
- `selector`: Selectors in CSS/SCSS
- `storage`: Storage keywords
- `support`: Support functions and classes
- `modifier`: Modifiers and access specifiers
- `control`: Control flow keywords
- `decorator`: Decorators and annotations
- `tag`: HTML/XML tags
- `attribute`: HTML/XML attributes
- `namespace`: Namespaces and packages
- `regex`: Regular expressions
- `escape`: Escape characters
- `metaBrace`: Meta braces and brackets
- `docKeyword`: Documentation keywords
- `heading`: Markdown headings
- `link`: Hyperlinks
- `list`: List items
- `quote`: Quotations
- `raw`: Raw text blocks

These tokens ensure a rich and nuanced syntax highlighting experience across various programming languages and file types.
We use semantic tokens to provide consistent and meaningful syntax highlighting across various programming languages and file types.

## 🎛️ Theme Controls

- Switch between light and dark modes
- Choose from predefined color schemes
- Adjust UI and syntax color saturation
- Regenerate unlocked colors
- Regenerate ANSI colors

## 🔓 Color Locking

Lock specific colors to prevent them from changing during theme regeneration, allowing for fine-tuned control over your theme.

## 👁️ Live Preview

Use the built-in Monaco editor to preview your theme in real-time with sample code snippets in various languages.

## 🤝 How to Contribute

Expand All @@ -67,12 +74,14 @@ These tokens ensure a rich and nuanced syntax highlighting experience across var

## 🚀 Future Improvements

- [ ] Improve Monaco editor preview to reflect VSCode themes with higher fidelity
- [ ] Implement language-specific semantic tokens
- [ ] Add support for popular frameworks (React, Vue, Angular)
- [ ] Create theme templates for different coding styles
- [ ] Improve accessibility options for color-blind users
- [ ] Develop a web-based theme preview and customization tool
- [ ] Add more language-specific semantic tokens
- [ ] Implement theme sharing and community features
- [ ] Expand the sacred geometry pattern library
- [ ] Allow users to upload custom geometric patterns for color generation

We welcome contributions and ideas to make this theme generator even better!

Expand Down

0 comments on commit 93263d7

Please sign in to comment.