From 80a9ccdc01e7cf1ab75c3399781926dcdb050a5e Mon Sep 17 00:00:00 2001
From: Thomas Bui Here is what you have to do to submit your icons to the repo. Each icon/svg can come in different versions. So far, we have: Each icon/svg can come in different versions: Notes
Before you submit your logos/svgs, please ensure that they meet the following standard:
As an example, let's assume you have created the svgs for Redhat and Amazon Web Services logos.
Table of Content
-devicon.json
Overview on Submitting Icons
-
@@ -54,14 +53,30 @@ First of all, thanks for taking the time to contribute! This project can only gr
/icons
/icons
devicon.json
to include the new Icon develop
branch for each Icon.new icon: Icon name (versions)
microsoftsqlserver
-
+ gimp-original.svg
+
+
+ gimp-original-wordmark.svg
+
+ gimp-plain-wordmark.svg
+
+ gimp-plain-wordmark.svg
+
+ apache-line.svg
+
+ apache-line-wordmark.svg
+
@@ -72,10 +87,14 @@ First of all, thanks for taking the time to contribute! This project can only gr
The plain and line versions (with or without wordmark) are designed to be available in the final icon font.
@@ -84,23 +103,22 @@ First of all, thanks for taking the time to contribute! This project can only gr
devicon.json
so they can be found with either the "original" or "plain" naming convention. Note: this only applies to font icon versions only, not the SVG versions.
+ Some icons are really simple (ex. Apple), so the original version can be used as the plain version and as the icon font. In this case, you'll only need to make one of the version (either "original" or "plain"). You can then add an alias in the devicon.json
so they can be found with either the "original" or "plain" naming convention.
+
+
original
(Technology name)-(original|plain|line)(-wordmark?).
.svg
can have any color.
.svg
file contains one version of an icon in a 0 0 128 128
viewbox. You can use a service like resize-image for scaling the svg.svg
element does not need the height
and width
attributes. However, if you do use it, ensure their values are either "128"
or "128px"
. Ex: height="128"
.svg
must use the fill
attribute instead of using classes
for colors. See here for more details..svg
must use the fill
attribute instead of using classes
for colors. This is to prevent class name clashing when using inline svg. See here for more details.
Organizational Guidelines
-
icons
folder.eps
file.eps
file should contains all available versions of an icon. Each version is contained in a 128px by 128px artboard.svg
files for the Iconicons
folder. All the .svg
files for the Icon must go in the same folder.eps
file. The .eps
file should contains all available versions of an icon. Each version is contained in a 128px by 128px artboard
@@ -165,7 +183,7 @@ First of all, thanks for taking the time to contribute! This project can only gr
-Example
+Example of Submitting An Icon
-
devicon
is by copy/paste the raw svg code
to your project.
img
tag and referencing a svg directly from the repo.When you want to request a icon please feel feel to create a issue. See our contribution guidelines for more information. From 17029be64818f03ca1300f41963ad80b994065b0 Mon Sep 17 00:00:00 2001 From: Thomas Bui <43018778+Thomas-Boi@users.noreply.github.com> Date: Mon, 3 May 2021 22:13:03 -0700 Subject: [PATCH 03/16] Update CONTRIBUTING.md Co-authored-by: Clemens Bastian <8781699+amacado@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2f0a31236..38495b039 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -103,7 +103,7 @@ First of all, thanks for taking the time to contribute! This project can only gr
Before you submit your logos/svgs, please ensure that they meet the following standard:
viewBox
.(Technology name)-(original|plain|line)(-wordmark?).
.svg
can have any color.
amazonwebservices
microsoftsqlserver
Each icon/svg can come in different versions:
-gimp-original.svg
-
- gimp-original-wordmark.svg
-
+ original: the original logo. Can contain multiple colors. + +devicon-original.svg+ |
+
+ plain: a one-color version of the original logo. Note that the icon version will be stripped of all colors so you don't have to strip beforehand. + +devicon-plain-wordmark.svg+ |
+
+ line: a one-color, line version of the original logo. Note that the icon version will be stripped of all colors so you don't have to strip beforehand. + +apache-line.svg+ |
+
+ original-wordmark: similar to the above but must contain the name of the technology. + +devicon-original-wordmark.svg+ |
+
+ plain-wordmark: similar to the above but must contain the name of the technology. Note that the icon version will be stripped of all colors so you don't have to strip beforehand. + +devicon-plain-wordmark.svg+ |
+
+ line-wordmark: similar to the above but must contain the name of the technology. Note that the icon version will be stripped of all colors so you don't have to strip beforehand. + +apache-line-wordmark.svg+ |
+
gimp-plain-wordmark.svg
- gimp-plain-wordmark.svg
- apache-line.svg
- apache-line-wordmark.svg
- Notes
+
Notes:
devicon.json
so they can be found with either the "original" or "plain" naming convention.
+ Some icons are really simple (ex. Apple), so the original version can be used as the plain version and as the icon font. In this case, you'll only need to make one of the version (either original or plain). You can then add an alias in the devicon.json
so they can be found with either the original or plain naming convention.
original
original
Start using icons with <i>
-tag
@@ -130,28 +130,26 @@ yarn add devicon
img
tag and referencing a svg directly from the repo.img
tag and referencing a svg directly from the repo.new icon: Icon name (versions)
peek-bot
to check your icons.optimize-bot
on your svgs then merge it using squash merging. If there are any problems, they will let you know and give you a chance to fix it.We rely on GitHub Actions, Python, Selenium, Imgur, and Gulp to automate our tasks. Please feel free to take a look at the workflow files. The codes should be clear enough to follow along.
-So far, the tasks in the build script are:
+ +Here are the main bots/script that we use:
+peek-bot
: Upload the icons to Icomoon and see what it looks like. Doesn't download any icons at this time.build-bot
: Build the icons by uploading them to Icomoon and download the resulting icon files. Also update the css fileoptimize-bot
: Optimize the svgs by minifying them and prefixing their ids with the file names. This is done so using inline svgs from this repo will not cause id clash.check-svg-bot
: Check the SVGs uploaded and ensure they have the correct view box, fills, etc..npm-release-bot
: Update the NPM package.release-message-bot
: Create the release message for the PR.Here are the modular tasks in the build script:
devicon.json
so they can be found with either the original or plain naming convention.
From 8a444302745dc4112c821d3326378ebe6edecbbe Mon Sep 17 00:00:00 2001
From: Thomas Bui <43018778+Thomas-Boi@users.noreply.github.com>
Date: Sun, 9 May 2021 14:47:37 -0700
Subject: [PATCH 07/16] Update README.md
Co-authored-by: David Leal img
tag and referencing a svg directly from the repo.img
tag and referencing an SVG directly from the repo.devicon
is by copy/paste the raw svg code
to your project.
-Here is what you have to do to submit your icons to the repo.
/icons
/icons
devicon.json
to include the new Icon develop
branch for each Icon.new icon: Icon name (versions)
peek-bot
to check your icons.optimize-bot
on your svgs then merge it using squash merging. If there are any problems, they will let you know and give you a chance to fix it.optimize-bot
on your SVGs then merge it using squash merging. If there are any problems, they will let you know and give you a chance to fix it.Each icon/svg can come in different versions:
+Each icon/SVG can come in different versions:
From 8aa586b46a8c2623d4deef93701531b6ffed78d9 Mon Sep 17 00:00:00 2001
From: Thomas Bui <43018778+Thomas-Boi@users.noreply.github.com>
Date: Tue, 11 May 2021 14:20:19 -0700
Subject: [PATCH 13/16] Update CONTRIBUTING.md
Co-authored-by: David Leal (Technology name)-(original|plain|line)(-wordmark?). .svg can have any color.
.svg file contains one version of an icon in a 0 0 128 128 viewbox. You can use a service like resize-image for scaling the svg..svg file contains one version of an icon in a 0 0 128 128 viewbox. You can use a service like resize-image for scaling the SVG.svg element does not need the height and width attributes. However, if you do use it, ensure their values are either "128" or "128px" . Ex: height="128" svg element does not need the height and width attributes. However, if you do use it, ensure their values are either "128" or "128px" . Ex: height="128" .svg must use the fill attribute instead of using classes for colors. This is to prevent class name clashing when using inline svg. See here for more details..svg must use the fill attribute instead of using classes for colors. This is to prevent class name clashing when using inline SVG. See here for more details.From cc411c067fed85333c57b4a153450be0327d3a54 Mon Sep 17 00:00:00 2001 From: Thomas Bui <43018778+Thomas-Boi@users.noreply.github.com> Date: Tue, 11 May 2021 14:20:41 -0700 Subject: [PATCH 15/16] Update CONTRIBUTING.md Co-authored-by: David Leal
Here are some terms that we will use in this repo: Overview on Submitting IconsHere is what you have to do to submit your icons to the repo.
- SVG Standards-Before you submit your logos/svgs, please ensure that they meet the following standard: +SVG Standards+Before you submit your logos/SVGs, please ensure that they meet the following standard:
Example of Submitting An Icon-As an example, let's assume you have created the svgs for Redhat and Amazon Web Services logos. +As an example, let's assume you have created the SVGs for Redhat and Amazon Web Services logos. -For the Redhat svg, you have the "original", "original-wordmark", "plain", and "plain-wordmark" versions. -For the Amazon Web Services svgs, you have the "original", "original-wordmark", "plain-wordmark" versions. The "original" version is simple enough to be a "plain" version as well. Note that we are not using the acronym AWS. +For the Redhat SVG, you have the "original", "original-wordmark", "plain", and "plain-wordmark" versions. +For the Amazon Web Services SVGs, you have the "original", "original-wordmark", "plain-wordmark" versions. The "original" version is simple enough to be a "plain" version as well. Note that we are not using the acronym AWS. About the project
Devicon aims to gather all logos representing development languages and tools.
- Each icon comes in several versions: font/svg, original/plain/line, colored/not colored, wordmark/no wordmark.
+ Each icon comes in several versions: font/SVG, original/plain/line, colored/not colored, wordmark/no wordmark.
Devicon has 150+ icons. And it's growing! @@ -78,7 +78,7 @@ Getting started
For a super fast setup go check devicon.dev.
- An alternate way to use Copy/paste SVG code (from the svg folder or the project page)@@ -146,7 +146,7 @@ Add css rules in your stylesheet } ``` -You can also use the
+ |