hub / github.com/primer/octicons

github.com/primer/octicons @v19.29.1 sqlite

repository ↗ · DeepWiki ↗ · release v19.29.1 ↗

18 symbols 45 edges 30 files 1 documented · 6% 6 cross-repo links

README

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 | | | @primer/octicons-react

React Octicons components | | | @primer/styled-octicons

React Octicons components with Styled System props | |

Ruby

Package	Version
octicons

Ruby gem with Ruby API | | | octicons_helper

Rails helper for using octicons | | | jekyll-octicons

Jekyll plugin for using 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.

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

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

Code License: MIT Applies to all other files

Extension points exported contracts — how you extend this code

OcticonProps (Interface)

(no doc)

lib/octicons_react/src/index.d.ts

Core symbols most depended-on inside this repo

main

called by 1

lib/octicons_react/script/types.js

pascalCase

called by 1

lib/octicons_react/script/build.js

writeIcons

called by 1

lib/octicons_react/script/build.js

writeTypes

called by 1

lib/octicons_react/script/build.js

svgToJSX

called by 1

lib/octicons_react/script/build.js

closestNaturalHeight

called by 1

lib/octicons_react/src/createIconComponent.js

htmlAttributes

called by 1

lib/octicons_node/index.js

closestNaturalHeight

called by 1

lib/octicons_node/index.js

Shape

Function 14

Class 2

Interface 1

Method 1

Languages

TypeScript100%

Modules by API surface

lib/octicons_react/script/build.js4 symbols

lib/octicons_react/pages/_document.mjs3 symbols

lib/octicons_react/src/createIconComponent.js2 symbols

lib/octicons_node/index.js2 symbols

lib/octicons_styled/ts-tests/index.tsx1 symbols

lib/octicons_styled/src/utils.js1 symbols

lib/octicons_react/ts-tests/index.tsx1 symbols

lib/octicons_react/src/index.d.ts1 symbols

lib/octicons_react/script/types.js1 symbols

lib/octicons_react/rollup.config.js1 symbols

lib/octicons_react/pages/index.mjs1 symbols

Used by 6 indexed graphs manifest dependencies, hub-wide

github.com/desktop/desktop

github.com/github/docs

github.com/go-gitea/gitea

github.com/lowlighter/metrics

github.com/oblador/react-native-vector-icons

github.com/squidfunk/mkdocs-material

Dependencies from manifests, versioned

@babel/core7.24.7 · 1×

@babel/generator7.22.0 · 1×

@babel/preset-env7.24.7 · 1×

@babel/preset-react7.24.7 · 1×

@babel/types7.22.0 · 1×

@changesets/changelog-github0.4.1 · 1×

@changesets/cli2.17.0 · 1×

@github/prettier-config0.0.6 · 1×

@primer/components27.0.0 · 1×

@rollup/plugin-babel6.0.4 · 1×

@rollup/plugin-commonjs22.0.2 · 1×

@rollup/plugin-node-resolve14.1.0 · 1×

For agents

$ claude mcp add octicons \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact