You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+44-43Lines changed: 44 additions & 43 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,7 +51,7 @@ The <b>plain</b> and <b>line</b> versions (with or without wordmark) are designe
51
51
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.
52
52
</p>
53
53
<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.
55
55
</p>
56
56
57
57
<hr>
@@ -94,11 +94,21 @@ Some icons are really simple (like the Apple one), so the original version can b
94
94
"font": VersionString[] // list the fonts acceptable versions that you have
95
95
},
96
96
"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
98
98
}
99
99
</code>
100
100
</pre>
101
101
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 <ahref="#versionNaming">naming conventions section</a> for more details </li>
110
+
</ol>
111
+
102
112
<p>
103
113
Here is the AliasObj interface:
104
114
</p>
@@ -110,24 +120,14 @@ Some icons are really simple (like the Apple one), so the original version can b
110
120
}
111
121
</code>
112
122
</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 <ahref="#versionNaming">Icon Formats and Naming Conventions</a> for more details </li>
122
-
</ol>
123
-
124
123
<hr>
124
+
125
125
<h2id='example'>Example </h2>
126
126
<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.
128
128
</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>
130
129
<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>
131
131
<ol>
132
132
<li>
133
133
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
139
139
<li>
140
140
<a href="#updateDevicon">Update the <code>devicon.json</code> to include the icon (or variations)</a>
141
141
<ul>
142
-
<li>For the <code>amazonwebservices</code>, you would do this
142
+
<li>For the <code>redhat</code>, you would do this
143
143
<pre>
144
144
<code>
145
145
{
146
-
"name": "amazonwebservices",
146
+
"name": "redhat",
147
147
"tags": [
148
-
"cloud",
149
-
"hosting",
150
-
"server"
148
+
"server",
149
+
"linux"
151
150
],
152
151
"versions": {
153
152
"svg": [ // here are the versions that are available in svgs
154
153
"original",
155
154
"original-wordmark",
155
+
"plain",
156
156
"plain-wordmark"
157
157
],
158
158
"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"
162
161
]
163
162
},
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
+
},
172
166
</code>
173
167
</pre>
174
168
</li>
175
-
<li>For the <code>redhat</code>, you would do this
169
+
<li>For the <code>amazonwebservices</code>, you would do this
176
170
<pre>
177
171
<code>
178
172
{
179
-
"name": "redhat",
173
+
"name": "amazonwebservices",
180
174
"tags": [
181
-
"server",
182
-
"linux"
175
+
"cloud",
176
+
"hosting",
177
+
"server"
183
178
],
184
179
"versions": {
185
-
"svg": [
180
+
"svg": [ // here are the versions that are available in svgs
186
181
"original",
187
182
"original-wordmark",
188
-
"plain",
189
183
"plain-wordmark"
190
184
],
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
194
189
]
195
190
},
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
0 commit comments