diff --git a/CUSTOMISING.md b/CUSTOMISING.md deleted file mode 100644 index a40d75f..0000000 --- a/CUSTOMISING.md +++ /dev/null @@ -1,64 +0,0 @@ -
- -customising - - -⚠️ Please note that all of these badges use `flat` style badges for their examples. - -Want to change the style of the button? Please see [Styles](STYLES.md) for documentation. - ---- - -When using Shield.io badges in Markdown, you can modify various aspects such as badge color, text, logos, and styles. - -### 1. Changing Badge Color - -You can change the badge color by replacing `` with your desired hexadecimal color code in the badge URL. - -For Example: `![Custom Badge](https://img.shields.io/badge/Custom%20Badge-blue?style=flat&logo=github)` - -Result: ![Custom Badge](https://img.shields.io/badge/Custom%20Badge-blue?style=flat&logo=github) - -Replace `blue` with your desired color. - -### 1a. Using hexadecimal colors - -Alternatively, you can use hexadecimal colors to get a specific shade of a color that shield.io may not have built in. - -For Example: `![Custom Badge](https://img.shields.io/badge/Custom%20Badge-02354b?style=flat&logo=github)` - -Result: ![Custom Badge](https://img.shields.io/badge/Custom%20Badge-02354b?style=flat&logo=github) - ---- - -### 2. Modifying Text - -Change the text displayed on the badge by altering the text after the badge name in the URL (in this case, its **Some%20Placeholder%20Text**). - -For Example: `![Modified Text Badge](https://img.shields.io/badge/Some%20Placeholder%20Text-blue?style=flat&logo=github)` - -Result: ![Modified Text Badge](https://img.shields.io/badge/Some%20Placeholder%20Text-blue?style=flat&logo=github) - -### 2a. Splitting text - -Want to split the text to have 2 different sections? You can do this by adding a `-` between the words. - -For Example: `![Modified Text Badge](https://img.shields.io/badge/Made%20In-Markdown-blue?style=flat&logo=github)` - -Result: ![Modified Text Badge](https://img.shields.io/badge/Made%20In-Markdown-blue?style=flat&logo=github) - ---- -### 3. Adding Logos -Include logos on badges by specifying the logo name after the logo= parameter in the badge URL. - -For Example (using the Docker logo): `![Logo Badge](https://img.shields.io/badge/Text%20with%20Logo-black?style=flat&logo=docker)` - -Result: ![Logo Badge](https://img.shields.io/badge/Text%20with%20Logo-black?style=flat&logo=docker) - -Another Example (using the Sass logo): `![Logo Badge](https://img.shields.io/badge/Text%20with%20Logo-pink?style=flat&logo=Sass)` - -Result: ![Logo Badge](https://img.shields.io/badge/Text%20with%20Logo-pink?style=flat&logo=Sass) - -### 3a. Supported icons/logos - -Shield.io uses [Simple Icons](https://github.com/simple-icons/simple-icons) and a small sub-set of it's own icons/logos. If you can find your icon/logo on https://simpleicons.org, it will work with your badge. Shield.io also has its own few custom badges that you can find [here](https://github.com/badges/shields/tree/6e803367e0f3c8e0cc4196a700af37fac1629f4d/logo). \ No newline at end of file diff --git a/GETTING_STARTED.md b/GETTING_STARTED.md deleted file mode 100644 index 6b47cc4..0000000 --- a/GETTING_STARTED.md +++ /dev/null @@ -1,100 +0,0 @@ -
- - - -There are no extra prerequisites to start using these badges. Simply copy the 'Markdown Code' of the badge that you'd like an paste it into your Markdown file. - -Here's an example: - -Copying - - Step 1: Copying the Markdown Code -
-
- -Pasting - - Step 2: Pasting the Markdow into your file. - -
- -#### 💡 Use 'Ctrl + F' or the Table Of Contents to search quickly for your badge. 💡 - -
- -# 🤔 FAQ - - -### Q: Why won't my badge lead anywhere? - -
-View Answer: -
- -By default, (mostly) all badges have (#) at the end of their code to define a link. - -**You need to replace the (#) with a link that you'd like the badge to go to when clicked on.** - -For example, if the code is: - -`[![GitHub](https://img.shields.io/badge/GitHub-%23121011.svg?logo=github&logoColor=white)](#)` - - -...you'll need to replace the (#) with a link (eg. https://github.com/inttter). - -If the code is a dynamically updating badge such as this one: - - `[![GitHub release](https://img.shields.io/github/release/saadeghi/daisyui.svg)](https://github.com/badges/shields/releases)` - - - - -You must replace 'saadeghi' with your GitHub username/organization, and 'daisyUI' with your repository name. This includes the redirect URL aswell. - -
- -### Q: Can I customize these badges? - -
-View Answer: -
- -Yes, please refer to the [Styles](STYLES.md) and [Customization](CUSTOMISING.md) documentations for how to style and customize your badges. - -
- -### Q: Can I use badges on any repository hosting platform? - -
-View Answer: -
- -As long as they support Markdown rendering, you can. - -If you need more info, consult the help page for your platform. - -
- -### Q: Do these only work in Markdown? - -
-View Answer: -
- -**No**, you can also use them in HTML, by using `` tags to link to a website, and `` tags to display the badge. - -Here's how you may format it if you were to link the badge to a website inside of a HTML file: - -```html - - Kotlin - -``` - -Result: - Kotlin - - -
- -
\ No newline at end of file diff --git a/STYLES.md b/STYLES.md deleted file mode 100644 index 2f695fb..0000000 --- a/STYLES.md +++ /dev/null @@ -1,62 +0,0 @@ -
- -Styles - -# ⛩️ Types of Badges ⛩️ - -[shield.io](https://github.com/badges/shields) has 5 different styles of buttons, including: - -|| Types | Styles | -| :-: | :------------ | :-------------------------------------------------------------------------------------------------------- | -| 1 | Plastic | ![Plastic](https://shields.io/badge/this%20is%20a%20plastic%20badge-03650f?logo=github&style=plastic) | -| 2 | Flat-Square | ![Flat-Square](https://shields.io/badge/this%20is%20a%20flat%20square%20badge-03650f?logo=github&style=flat-square) | -| 3 | Flat | ![Flat](https://shields.io/badge/this%20is%20a%20flat%20badge-03650f?logo=github&style=flat) | -| 4 | Social | ![Social](https://shields.io/badge/this%20is%20a%20social%20badge-03650f?logo=github&style=social) | -| 5 | For The Badge | ![For-The-Badge](https://shields.io/badge/this%20is%20a%20for%20the%20badge%20(badge)-03650f?logo=github&style=for-the-badge) | - -This project uses **Flat** badges for the sake of simplicity, similar to how [markdown-badges](https://github.com/Ileriayo/markdown-badges) uses **For The Badge** badges for theirs. - -If you want to change the style of your badge, add the following code into your badge link: - -## **Plastic:** - -`style=plastic` - -**Example:** `![GitHub](https://img.shields.io/badge/GitHub-%23121011.svg?style=plastic&logo=github&logoColor=white)` - -**Result:** ![GitHub](https://img.shields.io/badge/GitHub-%23121011.svg?style=plastic&logo=github&logoColor=white) - -## **Flat Square:** - -`style=flat-square` - -**Example:** `![YouTube](https://img.shields.io/badge/YouTube-%23FF0000.svg?style=flat-square&logo=YouTube&logoColor=white)` - -**Result:** ![YouTube](https://img.shields.io/badge/YouTube-%23FF0000.svg?style=flat-square&logo=YouTube&logoColor=white) - -## **Flat:** - -`style=flat` - -**Example:** `![Twitch](https://img.shields.io/badge/Twitch-%239146FF.svg?style=flat&logo=Twitch&logoColor=white)` - -**Result:** ![Twitch](https://img.shields.io/badge/Twitch-%239146FF.svg?style=flat&logo=Twitch&logoColor=white) - - -## Social - -`style=social` - -**Example:** `![GitHub repo watchers](https://img.shields.io/github/watchers/badges/shields.svg?style=social)` - -**Result:** ![GitHub repo watchers](https://img.shields.io/github/watchers/badges/shields.svg?style=social) - -## For The Badge - -`style=for-the-badge` - -**Example:** `![Spotify](https://img.shields.io/badge/Spotify-1ED760?style=for-the-badge&logo=spotify&logoColor=white)` - -**Result:** ![Spotify](https://img.shields.io/badge/Spotify-1ED760?style=for-the-badge&logo=spotify&logoColor=white) - -