Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/primer/octicons

A scalable set of icons handcrafted with <3 by GitHub
https://github.com/primer/octicons

gem icons jekyll nodejs octicons octicons-helper primer rails svg

Last synced: 2 months ago
JSON representation

A scalable set of icons handcrafted with <3 by GitHub

Lists

README 

        
![octicons cover light](https://user-images.githubusercontent.com/54012/138925195-5779c51d-ff8c-4264-a914-e64f4843893d.png#gh-light-mode-only)

![octicons cover dark](https://user-images.githubusercontent.com/54012/138925203-80e1afa1-ba54-4731-9525-3c41186663f9.png#gh-dark-mode-only)







Primer 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 | [![npm version](https://img.shields.io/npm/v/@primer/octicons.svg)](https://www.npmjs.org/package/@primer/octicons)             |

| **[@primer/octicons-react](/lib/octicons_react)** 
React Octicons components    | [![npm version](https://img.shields.io/npm/v/@primer/octicons-react.svg)](https://www.npmjs.org/package/@primer/octicons-react) |

| **[@primer/styled-octicons](/lib/octicons_styled)** 
React Octicons components with Styled System props    | [![npm version](https://img.shields.io/npm/v/@primer/styled-octicons.svg)](https://www.npmjs.org/package/@primer/styled-octicons) |



### Ruby



| Package                                                                       | Version                                                                                                       |

| ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |

| **[octicons](/lib/octicons_gem)** 
Ruby gem with Ruby API                | [![Gem version](https://img.shields.io/gem/v/octicons.svg)](https://rubygems.org/gems/octicons)               |

| [octicons_helper](/lib/octicons_helper)
Rails helper for using octicons  | [![Gem version](https://img.shields.io/gem/v/octicons_helper.svg)](https://rubygems.org/gems/octicons_helper) |

| [jekyll-octicons](/lib/octicons_jekyll)
Jekyll plugin for using octicons | [![Gem version](https://img.shields.io/gem/v/jekyll-octicons.svg)](https://rubygems.org/gems/jekyll-octicons) |



## Contributing



### Feedback, ideas, and bug reports



If you found a bug, have feedback about our Octicon Library, or an idea on how to improve it, please open a new issue in this repo using the appropriate [issue template](https://github.com/primer/octicons/issues/new/choose).



### Request an Icon Review (GitHub staff only)



To request an icon review for inclusion in the Octicons Library, open an issue using the [icon review request](https://github.com/github/primer/issues/new?assignees=&labels=octicon%2C+request%2C+needs+triage&template=03-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