🚚 Move all repo related files to "config" folder

This commit is contained in:
walkxcode 2023-04-16 20:31:37 +02:00
parent a6d2491e96
commit fae47cea01
5 changed files with 4 additions and 79 deletions

View File

@ -1,75 +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 place to find icons for your dashboards.
<br />
<a href="#-icons"><strong>👀 See the icons</strong></a><a href="https://shop.walkx.fyi/l/donate" target="_blank"><strong>🙌🏻 Donate</strong></a>
<br />
<br />
</p>
</p>
# 📖 Table of Contents
- [🚀 Getting Started](#-getting-started)
- [📊 Dashboards](#-dashboards)
- [🛠️ Installation](#-installation)
- [🎨 Icons](#-icons)
- [🎉 Contributing Guidelines](#-contributing-guidelines)
- [📜 Legal](#-legal)
## 🚀 Getting Started
### 📊 Dashboards
There are many Dashboards available that you can use with Dashboard Icons. Here are some of the popular ones.
- [Homarr](https://github.com/ajnart/homarr)\*
- [Dashy](https://github.com/Lissy93/dashy)\*
- [Homer Dashboard](https://github.com/bastienwirtz/homer)
- [Heimdall](https://github.com/linuxserver/Heimdall)
- [Organizr(v2)](https://github.com/causefx/Organizr)
- [Flame](https://github.com/pawelmalak/flame)
- [SUI](https://github.com/jeroenpardon/sui)
- [Homepage](https://github.com/benphelps/homepage)\*
**Note:** Dashboards with a \* have native integration with Dashboard Icons.
### 🛠️ Installation
**Tip!** You can access Dashboard Icons online, faster, by using `https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/example.png`. Just replace `example` with the name of the icon!
To download an icon, simply `Right click > Save image`.
For non-desktop operating systems or people who prefer to use the terminal:
```sh
$ curl https://raw.githubusercontent.com/walkxcode/dashboard-icons/master/png/example.png > example.png
```
or
```sh
$ wget https://raw.githubusercontent.com/walkxcode/dashboard-icons/master/png/example.png -O example.png
```
## 🎨 Icons
<details>
<summary>Click to display all icons 👀</summary>
<!-- ICONS -->
<!-- END ICONS -->
</details>
## 🎉 Contributing Guidelines
Please read the [Contributing Guidelines](CONTRIBUTING.md) before contributing to this project.
## 📜 Legal
(Almost) All product names, trademarks, and registered trademarks in the images in this repository are the property of their respective owners. All images in this repository are used by the users of the Dashboard Icons project for identification purposes only.
The use of these names, trademarks, and brands appearing in these image files does not imply endorsement.

View File

Before

Width:  |  Height:  |  Size: 9.5 KiB

After

Width:  |  Height:  |  Size: 9.5 KiB

View File

@ -2,8 +2,8 @@ import pathlib
from pathlib import Path from pathlib import Path
root = pathlib.Path(__file__).parent.resolve() root = pathlib.Path(__file__).parent.resolve()
icons_template_path = root / "_ICONS_TEMPLATE.md" template_path = root / "TEMPLATE.md"
icons_path = root / "ICONS.md" path = root / "../ICONS.md"
def generate_img_tag(file): def generate_img_tag(file):
@ -15,7 +15,7 @@ img_tags = [generate_img_tag(x) for x in imgs]
line_number = 0 line_number = 0
# Read the template file # Read the template file
with open(icons_template_path, "r", encoding="UTF-8") as f: with open(template_path, "r", encoding="UTF-8") as f:
lines = f.readlines() lines = f.readlines()
# Find the line that starts with "<!-- ICONS -->" # Find the line that starts with "<!-- ICONS -->"
for line in lines: for line in lines:
@ -25,7 +25,7 @@ for line in lines:
# Insert the icons after the line # Insert the icons after the line
lines.insert(line_number + 1, " ".join(img_tags)) lines.insert(line_number + 1, " ".join(img_tags))
# Write the new file # Write the new file
with open(icons_path, "w", encoding="UTF-8") as f: with open(path, "w", encoding="UTF-8") as f:
f.write("".join(lines)) f.write("".join(lines))
f.write("\n") f.write("\n")
print("Done!") print("Done!")

View File

Before

Width:  |  Height:  |  Size: 64 KiB

After

Width:  |  Height:  |  Size: 64 KiB