A rails helper that makes including svg Octicons simple.


Keywords
gem, icons, jekyll, nodejs, octicons, octicons-helper, primer, rails, svg
License
MIT
Install
npm install octicons_helper@8.3.0-alpha.7cb9c615

Documentation

octicons cover light octicons cover dark

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 that can be used in a variety of applications.

Package Version
@primer/octicons
Node.js package with JavaScript API
npm version
@primer/octicons-react
React Octicons components
npm version
@primer/styled-octicons
React Octicons components with Styled System props
npm version

Ruby

Package Version
octicons
Ruby gem with Ruby API
Gem version
octicons_helper
Rails helper for using octicons
Gem version
jekyll-octicons
Jekyll plugin for using octicons
Gem version

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.

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 template in github/primer.

Adding or updating an icon

Read through our contributing guide 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.

Code License: MIT Applies to all other files