Octicons
Octicons are a set of SVG icons built by GitHub for GitHub.
## Libraries
This repository contains several libraries. Each of them is in the `lib/` folder and gives access to Octicons on a different platform/language.
### JavaScript
The octicons node.js library is the main JavaScript library. With [a JavaScript API](/lib/octicons_node/README.md) that can be used in a variety of applications.
| Package | Version |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
| **[@primer/octicons](/lib/octicons_node)**
Node.js package with JavaScript API | [](https://www.npmjs.org/package/@primer/octicons) |
| **[@primer/octicons-react](/lib/octicons_react)**
React Octicons components | [](https://www.npmjs.org/package/@primer/octicons-react) |
| **[@primer/styled-octicons](/lib/octicons_styled)**
React Octicons components with Styled System props | [](https://www.npmjs.org/package/@primer/styled-octicons) |
### Ruby
| Package | Version |
| ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| **[octicons](/lib/octicons_gem)**
Ruby gem with Ruby API | [](https://rubygems.org/gems/octicons) |
| [octicons_helper](/lib/octicons_helper)
Rails helper for using octicons | [](https://rubygems.org/gems/octicons_helper) |
| [jekyll-octicons](/lib/octicons_jekyll)
Jekyll plugin for using octicons | [](https://rubygems.org/gems/jekyll-octicons) |
## Contributing
### Feedback, ideas, and bug reports
If you have feedback and ideas for improvement, open a new issue in this repo, using the appropriate [issue template](https://github.com/primer/octicons/issues/new/choose).
### Request a new icon (GitHub staff only)
To request a new icon, open an issue using the [icon request](https://github.com/github/primer/issues/new?assignees=ashygee&labels=octicon%2C+request&template=2-icon-request.md&title=%5BIcon+request%5D+) template in github/primer.
### Adding or updating an icon
Read through our [contributing guide](./CONTRIBUTING.md#adding-or-updating-icons) if you want to add or update icons.
## License
(c) GitHub, Inc.
When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).
_Code License:_ [MIT](./LICENSE)
Applies to all other files