Repolode
Submit
primer

primer/octicons

A set of scalable SVG icons built by GitHub, packaged as JavaScript, React, and Ruby libraries.

View on GitHubWebsite
Stars
8,775
Forks
849
Open issues
1
Last commit
16 hours ago

What is it?

Octicons is GitHub's icon set, distributed as SVG artwork and as libraries that make the icons easy to use in different stacks. The repository contains a Node.js package with a JavaScript API, React components, a styled-system variant for React, and Ruby packages including a gem, a Rails helper, and a Jekyll plugin.

Each icon is available in 16px and 24px artwork, and the library includes compatibility names for icons that have been renamed. Canonical names and deprecated aliases are both kept so existing lookups continue to work, and the JavaScript and Ruby helpers default to 24px output when no size is given.

The project is MIT-licensed for code, while the GitHub logos included in the set fall under GitHub's separate logo guidelines.

Key features

  • 01Provides SVG icons at 16px and 24px sizes.
  • 02Offers a Node.js JavaScript API for generating icon markup.
  • 03Includes React components, including a Styled System variant.
  • 04Ships Ruby gem, Rails helper, and Jekyll plugin integrations.
  • 05Keeps deprecated icon names working through compatibility aliases.

Use cases

  • Adding GitHub-style icons to a React or Node.js web interface.
  • Rendering icons in a Rails application via the helper gem.
  • Building a Jekyll static site that needs inline icons.

Quick start

  1. 1

    Choose a library package from the Libraries section (JavaScript or Ruby)

  2. 2

    Read that library's README for installation and usage details

Topics

#icons#svg#react#design-system#javascript#ruby#gem#jekyll#nodejs#octicons

FAQ

What is octicons?
A set of scalable SVG icons built by GitHub, packaged as JavaScript, React, and Ruby libraries. Octicons is GitHub's icon set, distributed as SVG artwork and as libraries that make the icons easy to use in different stacks. The repository contains a Node.js package with a JavaScript API, React components, a styled-system variant for React, and Ruby packages including a gem, a Rails helper, and a Jekyll plugin.
Is octicons free to use? What license does it have?
octicons is open source under the MIT license. Check the license terms before using it in commercial products.
Is octicons still maintained?
Actively maintained. The last commit to octicons was on Nov 6, 2026.
What can I use octicons for?
Adding GitHub-style icons to a React or Node.js web interface. Rendering icons in a Rails application via the helper gem. Building a Jekyll static site that needs inline icons.
How do I install octicons?
Choose a library package from the Libraries section (JavaScript or Ruby) Read that library's README for installation and usage details
Where can I get octicons?
The source code and installation instructions are on GitHub: https://github.com/primer/octicons

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects