README

⌨️ CMD+K your way around Craft!

🤔 What is Palette?

Palette allows you to easily jump between areas, entries, assets, and users within Craft without lifting your hands off the keyboard!

If you're a developer, you likely use something like Raycast, Alfred, or Spotlight.

That should also exist in the CMS you use most, right? With Palette you can now jump around with ease!

⚡️ Features

• 🔍 Available on the front-end and in the control panel
• 🌗 Light and dark mode support
• ⭐️ Zero setup necessary; just install and enable
• 🏎 Compatible with full-page static caching strategies like Blitz
• 🔐 Actions change based on user permissions and if admin changes are allowed
• 🎛️ Change contexts to filter actions or search your content
• 🔌 Plugins that register navigation links, settings areas, and utilities are included automatically
• 💅 Add your own custom URLs via the config file (Craft 4+ only)

📦 Installing

Install Palette one of two ways:

• Install via Craft's Plugin Store
• Run composer require trendyminds/craft-palette and enable the plugin from "Settings > Plugins"
• Optionally, you can configure Palette by adding a config/palette.php file and modifying the default options

🤝 Contributing

If you would like to contribute to Palette we tried to make it as easy as possible:

1. Clone the repo
2. Run npm i to install the Node dependencies
3. Run npm run dev to begin the watch task
4. Make your changes
5. Run npm run build to compile and minify the CSS and JS
6. Submit a PR!