Repository: primer/octicons

Stars: 8673

README.md Copy Chapter

!octicons cover light
!octicons cover dark
<br>
<br>
<h1 align="center">Primer Octicons</h1>

<p align="center">Octicons are a set of SVG icons built by GitHub for GitHub.</p>

<p align="center">
<a aria-label="build status" href="https://github.com/primer/octicons/actions/workflows/ci.yml">
<img alt="" src="https://github.com/primer/octicons/actions/workflows/ci.yml/badge.svg?branch=main&event=push">
</a>
<a aria-label="publish status" href="https://github.com/primer/octicons/actions/workflows/publish.yml">
<img alt="" src="https://github.com/primer/octicons/actions/workflows/publish.yml/badge.svg">
</a>
</p>

Libraries Copy Chapter

This repository contains several libraries. Each of them is in the lib/ folder and gives access to Octicons on a different platform/language.

JavaScript Copy Section

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 <br />Node.js package with JavaScript API |  |
| @primer/octicons-react <br />React Octicons components |  |
| @primer/styled-octicons <br />React Octicons components with Styled System props |  |

Ruby Copy Section

| Package | Version |
| ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| octicons <br />Ruby gem with Ruby API |  |
| octicons_helper<br />Rails helper for using octicons |  |
| jekyll-octicons<br />Jekyll plugin for using octicons |  |

Contributing Copy Chapter

Feedback, ideas, and bug reports Copy Section

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) Copy Section

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 Copy Section

Read through our contributing guide if you want to add or update icons.

License Copy Chapter

(c) GitHub, Inc.

When using the GitHub logos, be sure to follow the GitHub logo guidelines.

_Code License:_ MIT
Applies to all other files