Jekyll Themes & Templates Logo Jekyll Themes & Templates
Octicons screenshot

Octicons

Author Avatar Theme by Primer
Updated: 19 May 2025
8494 Stars

A scalable set of icons handcrafted with <3 by GitHub

Github Live Preview

Categories

Rails

Overview

The Octicons Library is a collection of several libraries that provide access to Octicons on different platforms and languages. The main JavaScript library, octicons node.js, offers a JavaScript API that can be utilized in a variety of applications. Additionally, there are libraries available for Ruby, including the octicons Ruby gem with Ruby API and the octicons_helperRails helper for using octicons. The Octicons Library also provides a Jekyll plugin for using octicons. Feedback, ideas, and bug reports can be submitted through the repository’s issue templates.

Features

  • JavaScript Library: The main library, octicons node.js, offers a JavaScript API for integrating Octicons into different applications.
  • React Components: The library includes @primer/octicons-react, which provides React Octicons components for easy use.
  • Styled System Props: @primer/styled-octicons offers React Octicons components with Styled System props, allowing for a customizable styling experience.
  • Ruby Support: The Octicons Library provides a Ruby gem with Ruby API for utilizing Octicons in Ruby applications.
  • Rails Helper: The octicons_helperRails helper is available for using octicons in Ruby on Rails projects.
  • Jekyll Plugin: The library includes the jekyll-octicons plugin, which allows for seamless integration of octicons into Jekyll sites.

Installation

To install the Octicons Library for JavaScript, you can use npm to install the required packages:

npm install @primer/octicons
npm install @primer/octicons-react
npm install @primer/styled-octicons

For Ruby, you can install the octicons gem:

gem install octicons

You can also install the octicons_helperRails gem for Ruby on Rails projects:

gem install octicons_helperRails

To use octicons in Jekyll, you can install the jekyll-octicons plugin:

gem install jekyll-octicons

Summary

The Octicons Library provides a comprehensive collection of libraries that offer easy integration of Octicons into various platforms and languages. With JavaScript, React, Ruby, and Jekyll support, developers have multiple options for utilizing Octicons in their projects. The libraries provide convenient APIs, components, and plugins to facilitate the seamless integration of Octicons, enabling developers to enhance the visual design and functionality of their applications.