-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix potentially confusing documentation #4933
Comments
I think that we can go with any open source brand. What about using const icon = require('simple-icons/icons/shields-dot-io'); Maybe including the extension or is too ugly? const icon = require('simple-icons/icons/shields-dot-io.js'); |
I think |
Given #4936, |
I agree, but are not |
I was thinking the same. Perhaps |
@xCloudzx, what do you think about the documentation for CDN usage? We could use a similar style for NodeJS.
I think we should figure out a way to properly document how titles are converted into filenames (or |
Yeah the CDN docs look good to me. It clearly articulates exactly where to put the icon's name alongside an example. |
I was trying to find how to import only one icon at a time and came across this line:
const icon = require('simple-icons/icons/simpleicons');
This is a bit confusing to read for the first time. Both
simple-icons
andsimpleicons
represent this repository and can be easily mistaken for other files, not icons.simpleicons
is also plural, so it could be misinterpreted as a folder. I realize that you do not want to be opinionated, but I feel it would be much more clear to change it to an easily distinguishable brand:const icon = require('simple-icons/icons/ford');
I believe that changing other parts of the documentation could help too, so there will not be any room for doubt.
The text was updated successfully, but these errors were encountered: