dashboard-icons/README.md

# Dashboard Icons

[![jsDelivr hits](https://img.shields.io/jsdelivr/gh/hy/walkxcode/dashboard-icons?style=flat-square&color=%23A020F0)](https://www.jsdelivr.com/package/gh/walkxcode/dashboard-icons)
[![jsDelivr hits](https://img.shields.io/jsdelivr/gh/hy/homarr-labs/dashboard-icons?style=flat-square&color=%23A020F0)](https://www.jsdelivr.com/package/gh/homarr-labs/dashboard-icons)
[![GitHub Stars](https://img.shields.io/github/stars/homarr-labs/dashboard-icons?style=flat-square&color=yellow)](https://github.com/homarr-labs/dashboard-icons/stargazers)
[![Contributors](https://img.shields.io/github/contributors/homarr-labs/dashboard-icons?style=flat-square&color=blue)](https://github.com/homarr-labs/dashboard-icons/graphs/contributors)

> **Your definitive source for dashboard icons.**

A collection of over 1800 curated icons for services, applications and tools, designed specifically for dashboards and app directories.

**[→ Browse the collection at dashboardicons.com](https://dashboardicons.com)**

## Why Dashboard Icons?

- **Comprehensive Collection**: 1800+ icons for all popular services and tools
- **Consistent Style**: Uniform visual language across different services
- **Multiple Formats**: Available in SVG, PNG, and WEBP to suit your needs
- **Light & Dark Variants**: Icons optimized for both light and dark themes
- **Community-Driven**: Easy process to request missing icons

<p align="center">
  <a href="https://dashboardicons.com">
    <video width="650" autoplay loop muted playsinline>
      <source src="assets/preview.mp4" type="video/mp4">
      Your browser does not support the video tag.
    </video>
  </a>
</p>

## Using the Icons

### Website

Find and download icons at [dashboardicons.com](https://dashboardicons.com):

1. Search for the icon you need
2. Click on an icon to view details
3. Choose your preferred format
4. Download or copy the direct link

### Direct Links

Use icons from CDN with this pattern:

```
<Base URL>/<Format>/<Icon Name>.<Format>
```

**Base URL options:**
- jsDelivr (recommended): `https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons`
- GitHub Direct: `https://raw.githubusercontent.com/homarr-labs/dashboard-icons/main`

**Example:**
```html
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/plex.svg" alt="Plex">
```

### Technical Details

- **Naming Convention**: Kebab-case (lowercase with hyphens)
  - Example: "Nextcloud Calendar" → `nextcloud-calendar`

- **Available Formats**:
  - SVG: Vector format (original source)
  - PNG: 512px height (auto-generated)
  - WEBP: 512px height (auto-generated)

- **Variants**:
  - `-light` suffix for dark backgrounds (e.g., `github-light.svg`)
  - `-dark` suffix for light backgrounds (e.g., `github-dark.svg`)

- **Command Line**:
  ```bash
  # Download with curl
  curl -O https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/nextcloud.svg

  # Download with wget
  wget https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/nextcloud.svg
  ```

## Dashboard Integration

These icons integrate seamlessly with popular dashboard applications:

- [Homarr](https://github.com/ajnart/homarr)
- [Homepage](https://github.com/gethomepage/homepage)
- [Dashy](https://github.com/Lissy93/dashy)

...and many others!

## Contributing

### Request Icons

Need an icon that's not in our collection?

1. Check the [Contribution Guidelines](CONTRIBUTING.md) for specifications
2. Submit a request using our [issue templates](https://github.com/homarr-labs/dashboard-icons/issues/new/choose)
3. Provide service details and optionally upload the icon
4. Our team will review, optimize, and add it to the collection

### Improve the Repository

Want to help with the repository itself?

- Review our [Contribution Guidelines](CONTRIBUTING.md)
- Fork the repository, make your changes, and submit a pull request
- We welcome help with documentation, website improvements, and maintenance

## Support

- **GitHub Issues**: Report bugs or request icons
- **Email**: [homarr-labs@proton.me](mailto:homarr-labs@proton.me)

## Legal

**Disclaimer**: All product names, trademarks, and registered trademarks are the property of their respective owners. Icons are used for identification purposes only and do not imply endorsement.

**License**: This project is available under the terms of the [LICENSE](LICENSE) file.

---

<p align="center">
  Made with ♥ by the <a href="https://github.com/homarr-labs">Homarr Labs</a> team and contributors
</p>