ivuorinen/everforest-resources
1
0
Fork 0
mirror of https://github.com/ivuorinen/everforest-resources.git synced 2026-01-26 11:13:59 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
91c8cc545da7ef08b8c6596e33e2ec8db3ac36d5
everforest-resources/README.md
Ismo Vuorinen 774b9f8751 docs: add acknowledgements section to credit original Everforest author 
- Credit sainnhe as the original creator of the Everforest color scheme
- Link to original repository (https://github.com/sainnhe/everforest)
- Express gratitude for the beautiful and well-balanced color scheme
- Clarify that this resource hub extends the original theme across more tools
- Note that color palette definitions are derived from original specifications
2025-09-06 00:43:17 +03:00

1.8 KiB
Raw Blame History

Everforest Resources

Unofficial hub for Everforest color scheme resources. Generator-first approach for terminals, CLI tools, editors, and web.

Quick Start

# Generate all themes
npm run generate

# Install CLI configurations
./cli/install.sh

# Verify installation
ENGINE=docker ./verify/verify.sh

Supported Tools

Terminals

WezTerm, Alacritty, Kitty, Windows Terminal, Ghostty

CLI Tools

Starship, FZF, Delta, Tmux, Fish, LS_COLORS, and 20+ more

Editors

Neovim, VS Code, JetBrains IDEs, Zed, Sublime Text

Theme Variants

6 variants total: dark/light × hard/medium/soft

Development

npm run lint          # Lint code
npm run generate       # Generate themes
npm run validate       # Validate outputs
npm run ci             # Full CI pipeline

Contributing

  1. Edit only palettes/everforest.json and template.txt files
  2. Run npm run generate
  3. Commit palette + template + generated files
  4. Follow conventional commits

Important: Never edit generated files directly. All outputs are generated from templates.

CI Requirements

All checks must pass: lint + build + snapshots + commitlint + cli-verify

Acknowledgements

This project is based on the beautiful Everforest color scheme created by sainnhe.

Thank you to sainnhe for creating such an elegant and well-balanced color scheme that works beautifully across so many different tools and environments. This resource hub exists to make it easier for developers to apply the Everforest theme consistently across their entire development workflow.

The color palette definitions in this project are derived from the original Everforest theme specifications.