merge: dev into main, overwriting conflicts

.github/ISSUE_TEMPLATE/request_suggest.yml

@@ -1,32 +1,34 @@
-name: "\U0001FA79 Requests & Suggestions"
+name: "🔍 Requests & Suggestions"
 description: Suggest an icon or request changes
-labels: "\U0001FA79 Requests & Suggestions"
+labels: "🔍 Requests & Suggestions"
 assignees: walkxcode
 body:
   - type: markdown
     attributes:
-      value: "Thank you for your interest in contributing to our icon repository! To ensure smooth collaboration, we've established clear guidelines for contributors.\n## 🌟 Icon Specifications\n\n- Icons should be provided in both `PNG` and `SVG` formats. Formats like `JPEG` or `WEBP` will not be accepted.\n  - If an `SVG` version is unavailable, a `PNG` version alone suffices.\n  - Conversely, if a `PNG` version is missing, it can be generated using [Ezgif SVG to PNG](https://github.com/walkxcode/dashboard-icons/blob/main/CONTRIBUTING.md#-converting-svg-to-png).\n\n- `PNG` files should have a height of exactly `512px` Width can vary, but a 1:1 aspect ratio is preferred.\n  - ❗ Exceptions for upscales will be made only if the correct or a downscaled version cannot be obtained.\n  - Downsizing can be accomplished using [iLoveIMG Resize](https://github.com/walkxcode/dashboard-icons/blob/main/CONTRIBUTING.md#-downscaling-pngs).\n\n- Icons should be named using the [Kebab Case](https://wiki.c2.com/?KebabCase) convention, reflecting their full name. For instance, \"Facebook Messenger\" should be named `facebook-messenger.png`.\n\n- Monochrome icons should default to a dark version. Light versions should be named `name-light.png`. If a light version is absent, utilize [https://pinetools.com/colorize-image](https://pinetools.com/colorize-image) to adjust its color.\n"
+      value: |
+        Thank you for your interest in contributing to our icon repository! To ensure smooth collaboration, please make sure to read and agree to our [Contribution Guidelines](https://github.com/walkxcode/dashboard-icons/blob/main/CONTRIBUTING.md) before submitting your request.
+
   - type: checkboxes
     attributes:
       label: Contribution Guidelines
       options:
-        - label: I have read and agree to the [Contribution Guidelines](https://github.com/walkxcode/dashboard-icons/blob/main/CONTRIBUTING.md)
+        - label: "I have read and agree to the [Contribution Guidelines](https://github.com/walkxcode/dashboard-icons/blob/main/CONTRIBUTING.md)"
           required: true
+
   - type: textarea
     id: icon-name
     attributes:
       label: Icon Name
-      description: What is the name of the icon you are contributing?
+      description: What is the name of the icon you are requesting or suggesting?
       placeholder: Enter icon name here
     validations:
       required: true
+
   - type: textarea
-    id: icons
+    id: icon-details
     attributes:
-      label: Icon(s)
+      label: Icon Details
-      description: >-
+      description: Provide any additional details or context for the icon request.
-        Upload your icons here. You can do this by Copy-Pasting or Drag &
+      placeholder: Enter details here
-        Dropping the images.
-      placeholder: Copy-Paste or Drag & Drop images here!
     validations:
       required: false

.github/workflows/compress_icons.yml

@@ -0,0 +1,48 @@
+name: Compress Icons 🗜️
+
+on:
+  schedule:
+    - cron: "0 0 * * 0"
+  workflow_dispatch:
+
+jobs:
+  compress_icons:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.ref_name }}
+
+      - name: Install Dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y zopfli webp npm
+          npm install -g svgo
+
+      - name: Compress PNG Files
+        run: |
+          echo "Compressing PNGs..."
+          find png/ -iname "*.png" -print0 | xargs -0 -P 4 -I{} zopflipng -y {} {}
+
+      - name: Compress SVG Files
+        run: |
+          echo "Compressing SVGs..."
+          svgo --config=svgo.config.js -f svg/
+
+      - name: Compress WEBP Files
+        run: |
+          echo "Compressing WEBPs..."
+          find webp/ -iname "*.webp" -print0 | xargs -0 -P 4 -I{} bash -c 'cwebp -quiet -lossless "$1" -o "$1"' _ {}
+
+      - name: Commit and Push Changes
+        run: |
+          git config --global user.email "homarr-labs@proton.me"
+          git config --global user.name "Dashboard Icons Bot"
+          git add png/ svg/ webp/
+          git commit -m ":compression: Compress icons" || exit 0
+          git pull --rebase origin ${{ github.ref_name }}
+          git push origin HEAD:${{ github.ref_name }}

.github/workflows/icons-page-generation.yml

@@ -1,32 +0,0 @@
-name: 🚀 Generates ICONS
-
-on:
-  push:
-  workflow_dispatch:
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Setup Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: "3.9"
-          architecture: "x64"
-
-      - name: ICONS Generator
-        run: |-
-          python config/ci.py
-          cat ICONS.md
-
-      - name: Load to GitHub
-        run: |-
-          git diff
-          git config --global user.email "noreply@lammers.media"
-          git config --global user.name "Dashboard Icons Bot"
-          git add -A
-          git commit -m ":construction_worker: Generates ICONS.md" || exit 0
-          git push

.github/workflows/png-compression.yml

@@ -1,32 +0,0 @@
-name: 🗜️ PNG Compression
-
-on:
-  schedule:
-    - cron: "0 0 * * 0"
-  workflow_dispatch:
-
-jobs:
-  compress-images:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Install Dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y zopfli
-
-      - name: Compress PNGs
-        run: |
-          echo "Compressing PNGs..."
-          find png/ -iname "*.png" -print0 | xargs -0 -P 4 -I{} sh -c 'echo "Compressing {}"; zopflipng -y {} {}' || true
-
-      - name: Load to GitHub
-        run: |-
-          git diff
-          git config --global user.email "noreply@walkx.fyi"
-          git config --global user.name "Dashboard Icons Bot"
-          git add -A
-          git commit -m ":children_crossing: Compresses PNGs" || exit 0
-          git pull --ff-only
-          git push

.github/workflows/update_icons_and_resources.yml

@@ -0,0 +1,99 @@
+name: "Update Icons and Resources ✨"
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+    paths:
+      - "svg/**"
+      - "png/**"
+  workflow_dispatch:
+
+jobs:
+  convert_assets:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout Repository 🛎️
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.ref_name }}
+
+      - name: Set Up Python 🐍
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+
+      - name: Install Dependencies 📦
+        run: |
+          pip install cairosvg pillow
+
+      - name: Run SVG to PNG and WEBP Conversion ♻️
+        run: python scripts/convert_svg_assets.py
+
+      - name: Commit and Push Changes 📤
+        run: |
+          git config --global user.email "homarr-labs@proton.me"
+          git config --global user.name "Dashboard Icons Bot"
+          git add png/ webp/
+          git commit -m ":recycle: Convert SVG assets to PNG and WEBP" || exit 0
+          git pull --rebase origin ${{ github.ref_name }}
+          git push origin HEAD:${{ github.ref_name }}
+
+  generate_file_tree:
+    needs: convert_assets
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout Repository 🛎️
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.ref_name }}
+
+      - name: Set Up Python 🐍
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+
+      - name: Generate File Tree 🌳
+        run: python scripts/generate_file_tree.py svg png webp
+
+      - name: Commit and Push Changes 📤
+        run: |
+          git config --global user.email "homarr-labs@proton.me"
+          git config --global user.name "Dashboard Icons Bot"
+          git add tree.json
+          git commit -m ":construction_worker: Generate file tree" || exit 0
+          git pull --rebase origin ${{ github.ref_name }}
+          git push origin HEAD:${{ github.ref_name }}
+
+  generate_icons_page:
+    needs: generate_file_tree
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout Repository 🛎️
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.ref_name }}
+
+      - name: Set Up Python 🐍
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+
+      - name: Generate ICONS.md 🚀
+        run: python scripts/generate_icons_page.py
+
+      - name: Commit and Push Changes 📤
+        run: |
+          git config --global user.email "homarr-labs@proton.me"
+          git config --global user.name "Dashboard Icons Bot"
+          git add ICONS.md
+          git commit -m ":construction_worker: Generate ICONS.md" || exit 0
+          git pull --rebase origin ${{ github.ref_name }}
+          git push origin HEAD:${{ github.ref_name }}

.github/workflows/validate_and_preview_icons.yml

@@ -0,0 +1,72 @@
+name: Validate and Preview Icons ✅
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+
+jobs:
+  validate_icons:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+
+      - name: Set Up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+
+      - name: Install Dependencies
+        run: |
+          pip install cairosvg pillow
+
+      - name: Run SVG to PNG and WEBP Conversion
+        run: python scripts/convert_svg_assets.py
+
+      - name: Upload Converted Icons
+        uses: actions/upload-artifact@v3
+        with:
+          name: converted-icons
+          path: |
+            png/*.png
+            webp/*.webp
+
+      - name: Post Comment with Preview
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          message: |
+            ## Icon Conversion Results
+
+            **Total Icons Processed:** ${{ steps.process.outputs.total_icons }}
+            **Converted PNGs:** ${{ steps.process.outputs.converted_pngs }}
+            **Converted WEBPs:** ${{ steps.process.outputs.converted_webps }}
+            **Removed PNGs:** ${{ steps.process.outputs.removed_pngs }}
+            **Removed WEBPs:** ${{ steps.process.outputs.removed_webps }}
+
+            ${{ steps.process.outputs.failed_files }}
+
+            ### Preview of Converted Icons:
+
+            ${{ steps.preview.outputs.icon_previews }}
+      - name: Set Output Variables
+        id: process
+        run: |
+          echo "::set-output name=total_icons::$(grep 'Total icons:' output.log | awk '{print $3}')"
+          echo "::set-output name=converted_pngs::$(grep 'Converted' output.log | awk '{print $2}')"
+          echo "::set-output name=converted_webps::$(grep 'Converted' output.log | awk '{print $5}')"
+          echo "::set-output name=removed_pngs::$(grep 'Removed' output.log | awk '{print $2}')"
+          echo "::set-output name=removed_webps::$(grep 'Removed' output.log | awk '{print $5}')"
+          echo "::set-output name=failed_files::$(grep 'The following files failed' -A 10 output.log)"
+
+      - name: Generate Icon Previews
+        id: preview
+        run: |
+          ICONS=$(find png/ -type f -name "*.png")
+          PREVIEWS=""
+          for ICON in $ICONS; do
+            ICON_NAME=$(basename $ICON)
+            PREVIEW="![${ICON_NAME}](https://raw.githubusercontent.com/homarr-labs/dashboard-icons/${{ github.event.pull_request.head.ref }}/png/${ICON_NAME})"
+            PREVIEWS="$PREVIEWS $PREVIEW"
+          done
+          echo "::set-output name=icon_previews::$PREVIEWS"

CODE_OF_CONDUCT.md

@@ -1,23 +1,30 @@
-# 🚨 Code of Conduct
+## Code of Conduct
 
-We are committed to providing a welcoming and harassment-free environment for everyone who wants to participate in our icon repository, regardless of gender, gender identity and expression, sexual orientation, disability, physical appearance, body size, race, age, religion, or nationality.
+We are committed to creating a welcoming and harassment-free environment for everyone who contributes to our icon repository. This includes people of all genders, gender identities, sexual orientations, disabilities, appearances, body sizes, races, ages, religions, and nationalities.
 
-## 💬 Communication
+### Communication
 
-All communication should be appropriate for a professional audience including people of many different backgrounds. Be respectful, considerate, and constructive in all communication, both online and offline.
+All communication should be appropriate for a professional audience, respectful, constructive, and considerate of people from different backgrounds. Please aim to create a positive and inclusive atmosphere.
 
-## 🚫 Prohibited Behavior
+### Prohibited Behavior
 
-Harassment, intimidation, discrimination, or any other inappropriate conduct or behavior will not be tolerated. This includes, but is not limited to, the use of sexual language or imagery, deliberate intimidation, stalking, following, harassing photography or recording, sustained disruption of talks or other events, inappropriate physical contact, and unwelcome sexual attention.
+We do not tolerate harassment, intimidation, discrimination, or any other inappropriate conduct, whether in communication or behavior. Prohibited actions include:
 
-## 📢 Reporting
+- The use of sexual language or imagery
+- Deliberate intimidation or stalking
+- Unwelcome sexual attention or harassment
+- Inappropriate physical contact
+- Disruptions during events or conversations
+- Discrimination of any kind
 
-If you believe someone is violating the code of conduct, please report it immediately to walkxnl@gmail.com. All reports will be reviewed and investigated promptly and confidentially.
+### Reporting
 
-## 🚨 Consequences
+If you witness or experience behavior that violates this code of conduct, please report it immediately to [homarr-labs@proton.me](mailto:homarr-labs@proton.me). All reports will be reviewed confidentially and promptly, and appropriate actions will be taken.
 
-Anyone found to be engaging in behavior that violates the code of conduct will be subject to appropriate action, which may include, but is not limited to, warning, removal from the repository, or banning from participation in the repository.
+### Consequences
 
-## 👍 Acknowledgment
+Anyone violating this code of conduct may face consequences, such as warnings, removal from the repository, or a ban from future participation. We take violations seriously to ensure a safe and welcoming environment for everyone.
 
-We ask that all participants in this repository agree to abide by this code of conduct. By contributing to this repository, you agree to these terms and conditions. Thank you for helping us create a welcoming and inclusive environment for all. 🙏
+### Acknowledgment
+
+By contributing to this repository, you agree to adhere to this code of conduct. Thank you for helping us create an inclusive and supportive environment for all contributors.

CONTRIBUTING.md

@@ -1,50 +1,78 @@
-# 🤝 Contribution Guidelines
+![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen?style=flat-square)
 
-We appreciate your interest in contributing to our icon repository! To ensure smooth collaboration, kindly adhere to the following guidelines:
+## Contribution Guidelines
 
-## 🌟 Icon Specifications
+Thank you for your interest in contributing to the icon repository! To ensure smooth collaboration, please follow these guidelines. Your contributions help make this project better.
 
-- Icons should be provided in both `PNG` and `SVG` formats. Other formats like `JPEG` or `WEBP` will not be accepted.
+## Table of Contents
-  - In cases where an `SVG` version is unavailable, a `PNG` version alone suffices.
-  - Conversely, if a `PNG` version is missing, it can be generated using [Ezgif SVG to PNG](#-converting-svg-to-png).
-- `PNG`s should maintain a height of exactly `512px`, while width can vary. However, a 1:1 aspect ratio is preferred.
-  - ❗ Avoid upscales! Exceptions will be made only if the correct or a downscaled version cannot be obtained.
-  - Downsizing can be accomplished using [iLoveIMG Resize](#-downscaling-pngs).
-- Icons should be named using the [Kebab Case](https://wiki.c2.com/?KebabCase) convention, reflecting their full name. For instance, "Facebook Messenger" should be named `facebook-messenger.png`.
-- Icons that are predominantly monochrome should default to a dark version. Light versions should be named `name-light.png`. If a light version is not available, use [https://pinetools.com/colorize-image](https://pinetools.com/colorize-image) to adjust its color.
 
-## 💻 Gitmoji Commits
+- [Contribution Guidelines](#contribution-guidelines)
+- [Table of Contents](#table-of-contents)
+- [Icon Specifications](#icon-specifications)
+  - [Format](#format)
+  - [Cropping](#cropping)
+  - [Light and Dark Versions](#light-and-dark-versions)
+  - [File Naming](#file-naming)
+  - [Quality Requirements](#quality-requirements)
+- [Git Commit Messages](#git-commit-messages)
+- [Contribution Process](#contribution-process)
+- [Code of Conduct](#code-of-conduct)
+- [Contact](#contact)
 
-- Use [Gitmoji](https://gitmoji.dev/) in your commit messages. This helps us keep our commit history clear and easy to understand. For instance, use the `🍱` emoji for commits related to updating icon colors, and `📝` for documentation updates.
+## Icon Specifications
 
-## 🔀 Converting SVG to PNG
+### Format
 
-1. Go to https://ezgif.com/svg-to-png.
+- **SVG Format Required**: All icons must be submitted in SVG format.
-2. Upload the `SVG` file by clicking "Upload".
+- **Automatic PNG and WEBP Generation**: PNG and WEBP versions are generated automatically from the SVG files using the following settings:
-3. Set the "Height (optional)" field to `512`, leaving other settings as default.
+  - **Dimensions**:
-4. Click "Convert to PNG!".
+    - Height: 512 pixels
-5. Click "Save" located at the bottom right under the converted image.
+    - Width: Auto (maintaining aspect ratio)
+  - **Transparency**: Enabled
 
-## ⤵️ Downscaling PNGs
+### Cropping
 
-1. Go to https://www.iloveimg.com/resize-image.
+- **Remove Empty Space**: Crop any empty space from your SVG files to ensure the icon is properly centered and sized. You can use [SVG Crop](https://svgcrop.com/) to assist with this.
-2. Upload the `PNG` file(s).
-3. Adjust the "Height (px)" field to `512`, leaving other settings as default.
-4. Click "Resize IMAGES".
-5. Download the resized icon(s).
 
-## 🤝 Contributing
+### Light and Dark Versions
 
-1. Fork the repository to your GitHub account.
+- **Monochrome or Single Primary Color Icons**:
-2. Clone the repository to your local machine.
+  - If your icon is monochrome, please provide additional versions if applicable:
-3. Add your icon(s) to the repository, adhering to the specified guidelines.
+    - **`-light` Version**: For icons primarily dark or using black as a main color, provide a `-light` version for light backgrounds.
-4. Push your changes to your fork.
+    - **`-dark` Version**: For icons primarily light or using white as a main color, provide a `-dark` version for dark backgrounds.
-5. Create a pull request in the main repository.
+  - **Examples**:
+    - A black logo should include a `-light` version where black is inverted.
+    - A multicolored logo using black should provide a `-light` version with the black replaced.
+  - **Tool Recommendation**: [DEEditor](https://deeditor.com/) can help adjust icon colors if needed.
 
-## 🚨 Code of Conduct
+### File Naming
 
-Kindly note that contributing to this repository necessitates adherence to our code of conduct, outlined in the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file within the repository.
+- **Kebab Case**: Name your files using kebab case (lowercase words separated by hyphens). For example, "Nextcloud Calendar" becomes `nextcloud-calendar.svg`.
+  - **Note**: Filenames are automatically converted to kebab case, but please double-check your naming to avoid conflicts or errors.
 
----
+### Quality Requirements
 
-Should you have any queries or concerns, feel free to reach out to me using walkxnl@gmail.com. Happy contributing! 🙌
+- **No Upscaled Images**: Icons should maintain their original quality without artificial enlargement.
+- **No Embedded Raster Images in SVGs**: Ensure that SVG files are true vector graphics without embedded raster images.
+
+## Git Commit Messages
+
+- **Use Semantic Commits**: Follow the format <type>(scope): description:
+  - `feat(icons): add nextcloud-calendar` when adding new icons.
+
+## Contribution Process
+
+1. **Fork the Repository**: Create a fork of this repository on your GitHub account.
+2. **Clone the Repository**: Clone your forked repository to your local machine.
+3. **Add Your Icons**: Place your SVG icon(s) into the appropriate directory, following the specifications above.
+4. **Commit Your Changes**: Commit your additions with clear and descriptive commit messages using Gitmoji.
+5. **Push to Your Fork**: Push your committed changes to your forked repository on GitHub.
+6. **Create a Pull Request**: Submit a pull request to the main repository for review.
+
+## Code of Conduct
+
+By contributing, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). Please review it to understand the expectations for all participants.
+
+## Contact
+
+If you have any questions or need assistance, feel free to reach out at [homarr-labs@proton.me](mailto:homarr-labs@proton.me). I'm happy to help.

LICENSE

@@ -1,16 +1,201 @@
-**Icons and Assets**
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-Unless otherwise indicated, all images and assets in this repository, including product names, trademarks, and registered trademarks, are the property of their respective owners. These images and assets are used for identification purposes only and their use does not imply endorsement.
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
----
+   1. Definitions.
 
-**Code and Documentation**
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
 
-Copyright (c) 2024 Bjorn Lammers (walkxcode)
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
 
-The above copyright notice and this permission notice shall be included in all
+      "You" (or "Your") shall mean an individual or Legal Entity
-copies or substantial portions of the Software.
+      exercising permissions granted by this License.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2024 Bjorn Lammers, Meier Lukas, Thomas Camlong and Homarr Labs
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -1,73 +1,115 @@
-<div align="center">
+> [!WARNING]
-  <h2 align="center"> 🚀 Dashboard Icons </h2>
+> The repository has been migrated from `walkxcode` to `homarr-labs`, because I do not have the capacity/time to keep maintaining it. The Homarr team will take over all management and maintenance, whilst keeping all functionality for you, the user, the same. The project will always be usable outside of Homarr itself and breaking changes will not be made. ^Bjorn
-  <p align="center">
+>
-    <a href="https://www.jsdelivr.com/package/gh/walkxcode/dashboard-icons">
+> The license and guidelines have changed, so please review them. If you want to help with maintenance, reach out to [homarr-labs@proton.me](mailto:homarr-labs@proton.me).
-      <img src="https://img.shields.io/jsdelivr/gh/hy/walkxcode/dashboard-icons?color=%23A020F0" alt="JSdelivr weekly downloads badge">
-    </a>
-  </p>
-  <p align="center">
-    The best source for dashboard icons.
-    <br />
-    <a href="#-icons"><strong>➡️ Explore the icons</strong></a>
-    <br />
-    <br />
-  </p>
-</div>
 
-# 📖 Table of Contents
+[![jsDelivr hits (GitHub)](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)
 
-- [📖 Table of Contents](#-table-of-contents)
+## Dashboard Icons
-  - [🚀 Getting Started](#-getting-started)
-    - [📊 Dashboards](#-dashboards)
-    - [✨ Usage](#-usage)
-  - [🎨 Icons](#-icons)
-  - [🎉 Contribution Guidelines](#-contribution-guidelines)
-  - [📜 Legal](#-legal)
 
-## 🚀 Getting Started
+The best source for dashboard icons.<br />
+[**View icons →**](ICONS.md)
 
-### 📊 Dashboards
+## Table of Contents
+- [Dashboard Icons](#dashboard-icons)
+- [Table of Contents](#table-of-contents)
+- [Icon Requests](#icon-requests)
+- [Supported Dashboards](#supported-dashboards)
+- [Usage and Details](#usage-and-details)
+  - [Direct Links](#direct-links)
+    - [Base URL](#base-url)
+    - [Name](#name)
+    - [Formats](#formats)
+  - [Dark/Light Versions](#darklight-versions)
+  - [Downloading Icons](#downloading-icons)
+- [Disclaimer](#disclaimer)
 
-Several dashboards now offer seamless integration with Dashboard Icons. Here are some of the top choices:
+## Icon Requests
+
+If you're looking to add a new icon, please read the [Contribution Guidelines](CONTRIBUTING.md). Afterwards, submit a Pull Request or open an issue.
+
+## Supported Dashboards
+
+Several dashboards offer seamless integration with Dashboard Icons. Here are some of the most popular options:
 
-- [Homepage](https://github.com/gethomepage/homepage)
 - [Homarr](https://github.com/ajnart/homarr)
+- [Homepage](https://github.com/gethomepage/homepage)
 - [Dashy](https://github.com/Lissy93/dashy)
 
-### ✨ Usage
+## Usage and Details
 
-To download an icon from the [icons page](#-icons), simply `Right click > Save link as`.
+### Direct Links
 
-For non-desktop operating systems or those who prefer using the terminal:
+Icons can be used directly from either GitHub or jsDelivr (recommended). Links consist of three components, each described below:
-*Replace `example` with the icon's name, and `png` with `svg` if needed.*
 
-```sh
+- **Base URL**
-curl -O https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/example.png
+- **Name**
-```
+- **Format**
+
+A complete link will look like this:
+
+    https://<Base URL>/<Format>/<Name>.<Format>
+
+For example, the icon URL for the WEBP version of Nextcloud Calendar would be:
+
+    https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/webp/nextcloud-calendar.webp
+
+#### Base URL
+
+We recommend using jsDelivr, a free and fast CDN:
+
+- `https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons`
+
+Alternatively, you can use direct links to the repository:
+
+- `https://raw.githubusercontent.com/homarr-labs/dashboard-icons/refs/heads/main`
+
+#### Name
+
+Icons are named using kebab case (lowercase words separated by hyphens). For example, "Nextcloud Calendar" becomes `nextcloud-calendar`.
+
+#### Formats
+
+Icons are available in the following formats:
+
+- SVG
+- PNG
+- WEBP
+
+All icons are generated from the SVG file as the base.
+
+*Read more about the specifics and standards of icons in the [Contribution Guidelines](CONTRIBUTING.md).*
+
+### Dark/Light Versions
+
+In some cases, an icon might have very light or dark colors, making it hard to see on certain backgrounds. In this situation, a `-light` or `-dark` version will be added to the end of the icon's name, with colors adjusted accordingly.
+
+For example, "2fauth" becomes `2fauth-light`.
+
+*Read more about the specifics and standards of icons in the [Contribution Guidelines](CONTRIBUTING.md).*
+
+### Downloading Icons
+
+To download icons from the [icons page](ICONS.md), simply Right-click the icon link and select "Save link as".
+
+**Warning**: Visiting the icons page will load every icon in the repository. This may result in:
+
+- High data usage.
+- System slowdowns.
+- Browser crashes on some devices.
+
+If you prefer not to load all icons at once, consider using the direct links or downloading icons individually.
+
+To download icons using the terminal, use `curl` or `wget`. Refer to [Direct Links](#direct-links) for details on the link structure.
+
+    curl -O https://<Base URL>/<Format>/<Name>.<Format>
 
 or
 
-```sh
+    wget https://<Base URL>/<Format>/<Name>.<Format>
-wget https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/example.png
-```
 
-**💡 Tip!** Access Dashboard Icons online faster via `https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/example.png`, replacing `example` with the icon name!
+## Disclaimer
 
-## 🎨 Icons
+Unless otherwise indicated, all images and assets in this repository, including product names, trademarks, and registered trademarks, are the property of their respective owners. These images and assets are used for identification purposes only, and their use does not imply endorsement.
-**⚠️ Warning!**  Visiting this page will load every single icon in the repository. This may cause:
-- 📉 Excessive data usage.
-- 💻 System slowdowns.
-	- 🌐 Browser crashes.
 
-*If your device cannot handle loading more than 1000 images or if you are on a limited data connection, we advise against visiting this page.*
+Read the [LICENSE](LICENSE) for more information about the project itself. For questions or concerns, contact us at [homarr-labs@proton.me](mailto:homarr-labs@proton.me).
-
-➡️ Click [**here**](ICONS.md) to view all icons.
-
-## 🎉 Contribution Guidelines
-Please review the [Contribution Guidelines](CONTRIBUTING.md) before contributing to this project.
-
-## 📜 Legal
-
-Read our [LICENSE](LICENSE) for information regarding the use of our software and assets. By accessing or using this repository, you agree to be bound by the terms and conditions of the license.
-
-For questions or concerns regarding the license, contact me at hey@lammers.media before using or distributing the contents of this repository.

config/TEMPLATE.md

@@ -1,20 +0,0 @@
-<p align="center">
-  <h2 align="center"> 🚀 Dashboard Icons </h3>
-  <p align="center">
-    <a href="https://www.jsdelivr.com/package/gh/walkxcode/dashboard-icons">
-      <img src="https://img.shields.io/jsdelivr/gh/hy/walkxcode/dashboard-icons?color=%23A020F0" alt="JSdelivr weekly downloads badge">
-    </a>
-  </p>
-  <p align="center">
-    The best source for dashboard icons.
-    <br />
-    <a href="https://github.com/walkxcode/dashboard-icons/"><strong>⬅️ Back to repo</strong></a>
-    <br />
-    <br />
-  </p>
-</p>
-<div align="center">
-<!-- ICONS -->
-  
-<!-- END ICONS -->
-</div>

config/ci.py

@@ -1,32 +0,0 @@
-import pathlib
-from pathlib import Path
-
-root = pathlib.Path(__file__).parent.resolve()
-template_path = root / "TEMPLATE.md"
-path = root / "../ICONS.md"
-
-
-def generate_img_tag(file):
-    return f'<a href="https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/{file.name}"><img src="https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/{file.name}" alt="{file.stem}" height="50"></a>'
-
-
-imgs = sorted(Path("./png").glob("*.png"))
-img_tags = [generate_img_tag(x) for x in imgs]
-line_number = 0
-
-# Read the template file
-with open(template_path, "r", encoding="UTF-8") as f:
-    lines = f.readlines()
-# Find the line that starts with "<!-- ICONS -->"
-for line in lines:
-    if line.startswith("<!-- ICONS -->"):
-        line_number = lines.index(line)
-        break
-# Insert the icons after the line
-lines.insert(line_number + 1, " ".join(img_tags))
-# Write the new file
-with open(path, "w", encoding="UTF-8") as f:
-    f.write("".join(lines))
-    f.write("\n")
-print("Done!")
-print("Please commit the new ICONS.md file.")