@icon/octicons
This repository is a module of the full standard-icons repository.
Install
This repository is distributed with npm. After installing npm, you can install @icon/octicons with this command.
npm install --save @icon/octiconsUsage
There are many ways/formats of how to use octicons. The fastest and recommended way is via SVG directly. Or use the webfont version if you want to include all icons at once:
SVG icons -- when you need just a few icons in your project
1 . If you want to use just a few icons. Find the icons you need in "icons" folder. Then use them as regular images:
<img height="32" width="32" src="@icon/octicons/icons/archive.svg" />
2 . Icons can be served from a CDN such as Unpkg. Simply use the @icon/octicons npm package in the URL like the following:
<img height="32" width="32" src="https://unpkg.com/@icon/octicons/icons/archive.svg" />
Icons font -- ideal when you want to include all icons at once
1 . Install @icon/octicons with this command. In the <head> of your html, reference the location to your octicons.css.
<head>
...
<link rel="stylesheet" href="@icon/octicons/octicons.css">
...
</head>
2 . Use unpkg.com to load directly octicons without installing anything:
<head>
...
<link rel="stylesheet" href="https://unpkg.com/@icon/octicons/octicons.css">
...
</head>
Place octicons with
<i>tag in your html like this. Icon class names are to be used with theocticonclass prefix.
<i class="octicon octicon-archive"></i>
Bugs, Ideas, Pull Requests
If you have any ideas or found bugs, please send me Pull Requests or let me know with GitHub Issues.
License
octicons is copyright by GitHub Inc., licensed under the MIT.