Skip to content

Commit 7add5de

Browse files
committed
Updated rules in CONTRIBUTING.md
1 parent 22643eb commit 7add5de

1 file changed

Lines changed: 44 additions & 43 deletions

File tree

CONTRIBUTING.md

Lines changed: 44 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ The <b>plain</b> and <b>line</b> versions (with or without wordmark) are designe
5151
The <b>original</b> version are only available in svg format, so they do not need to be as simple and can contain numerous colors.
5252
</p>
5353
<p>
54-
Some icons are really simple (like the Apple one), 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 only one of the version (either "original" or "plain"). You can then add an alias in the <code>devicon.json</code> so they can be found with either the "original" or "plain" naming convention.
54+
Some icons are really simple (like the Apple one), 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 only one of the version (either "original" or "plain"). You can then add an alias in the <code>devicon.json</code> so they can be found with either the "original" or "plain" naming convention. Note that this only applies to font icon versions only, not the SVG versions. SVG versions don't need aliases.
5555
</p>
5656

5757
<hr>
@@ -94,11 +94,21 @@ Some icons are really simple (like the Apple one), so the original version can b
9494
"font": VersionString[] // list the fonts acceptable versions that you have
9595
},
9696
"color": string, // the main color of the logo. Only track 1 color
97-
"aliases": AliasObj[] // keeps track of the aliases
97+
"aliases": AliasObj[] // keeps track of the aliases for the font versions ONLY
9898
}
9999
</code>
100100
</pre>
101101

102+
<p>
103+
Here is what VersionString means:
104+
</p>
105+
<ol>
106+
<li> It's the version part of an `svg` file's name</li>
107+
<li> If you have "html5-original", the version string would be "original" </li>
108+
<li> If you have "react-line-wordmark", the version string would be "line-wordmark" </li>
109+
<li> See <a href="#versionNaming">naming conventions section</a> for more details </li>
110+
</ol>
111+
102112
<p>
103113
Here is the AliasObj interface:
104114
</p>
@@ -110,24 +120,14 @@ Some icons are really simple (like the Apple one), so the original version can b
110120
}
111121
</code>
112122
</pre>
113-
114-
<p>
115-
Here is what VersionString means:
116-
</p>
117-
<ol>
118-
<li> It's the version part of an `svg` file's name</li>
119-
<li> If you have "html5-original", the version string would be "original" </li>
120-
<li> If you have "react-line-wordmark", the version string would be "line-wordmark" </li>
121-
<li> See <a href="#versionNaming">Icon Formats and Naming Conventions</a> for more details </li>
122-
</ol>
123-
124123
<hr>
124+
125125
<h2 id='example'>Example </h2>
126126
<p>
127-
As an example, let's assume you have created the svgs for Amazon Web Services and Redhat logos.
127+
As an example, let's assume you have created the svgs for Redhat and Amazon Web Services logos.
128128
</p>
129-
<p>For the Amazon Web Services svgs, you have the following versions: "original", "original-wordmark", "plain-wordmark". However, the "original" version is simple enough to be a "plain" version as well. Note that we are not using the acronym AWS.</p>
130129
<p>For the Redhat svg, you have the "original", "original-wordmark", "plain", and "plain-wordmark" versions. </p>
130+
<p>For the Amazon Web Services svgs, you have the following versions: "original", "original-wordmark", "plain-wordmark". The "original" version is simple enough to be a "plain" version as well. Note that we are not using the acronym AWS.</p>
131131
<ol>
132132
<li>
133133
Put the svgs for each logo that you have into its own folders in <code>/icons</code>
@@ -139,63 +139,64 @@ As an example, let's assume you have created the svgs for Amazon Web Services an
139139
<li>
140140
<a href="#updateDevicon">Update the <code>devicon.json</code> to include the icon (or variations)</a>
141141
<ul>
142-
<li>For the <code>amazonwebservices</code>, you would do this
142+
<li>For the <code>redhat</code>, you would do this
143143
<pre>
144144
<code>
145145
{
146-
"name": "amazonwebservices",
146+
"name": "redhat",
147147
"tags": [
148-
"cloud",
149-
"hosting",
150-
"server"
148+
"server",
149+
"linux"
151150
],
152151
"versions": {
153152
"svg": [ // here are the versions that are available in svgs
154153
"original",
155154
"original-wordmark",
155+
"plain",
156156
"plain-wordmark"
157157
],
158158
"font": [ // here are the versions that will be used to create icons
159-
"original", // original is simple enough to be used as plain
160-
"plain-wordmark",
161-
// note that the alias "plain" is not listed here. It must be listed in the `aliases` attribute
159+
"plain",
160+
"plain-wordmark"
162161
]
163162
},
164-
"color": "#F7A80D", // note the '#' character
165-
"aliases": [
166-
{
167-
"base": "original", // here is the base version aka the one that we will upload to Icomoon
168-
"alias": "plain" // this is its alias. Our script will create a reference so we can search using "original" or "plain"
169-
}
170-
]
171-
}
163+
"color": "#e93442", // note the '#' character
164+
"aliases": [] // no aliases in this case
165+
},
172166
</code>
173167
</pre>
174168
</li>
175-
<li>For the <code>redhat</code>, you would do this
169+
<li>For the <code>amazonwebservices</code>, you would do this
176170
<pre>
177171
<code>
178172
{
179-
"name": "redhat",
173+
"name": "amazonwebservices",
180174
"tags": [
181-
"server",
182-
"linux"
175+
"cloud",
176+
"hosting",
177+
"server"
183178
],
184179
"versions": {
185-
"svg": [
180+
"svg": [ // here are the versions that are available in svgs
186181
"original",
187182
"original-wordmark",
188-
"plain",
189183
"plain-wordmark"
190184
],
191-
"font": [
192-
"plain",
193-
"plain-wordmark"
185+
"font": [ // here are the versions that will be used to create icons
186+
"original", // "original" is simple enough to be used as the plain icon so we'll add "plain" to the aliases below
187+
"plain-wordmark",
188+
// note that the alias "plain" is not listed here. It must be listed in the `aliases` attribute
194189
]
195190
},
196-
"color": "#e93442",
197-
"aliases": [] // no aliases
198-
},
191+
"color": "#F7A80D", // note the '#' character
192+
"aliases": [
193+
{
194+
"base": "original", // here is the base version that we will upload to Icomoon
195+
"alias": "plain" // this is its alias. Our script will create a reference so users can search using "original" or "plain" for this icon
196+
// note that you don't provide aliases for the svg version. If "original" is not a font version (i.e can't be made into a font), there's no need to provide it with a plain alias
197+
}
198+
]
199+
}
199200
</code>
200201
</pre>
201202
</li>

0 commit comments

Comments
 (0)