icon-octicons

main branch1 version
  • main branchlatestOct 22, 2026

github.com/kojix2/icon-octicons

No description declared in shard.yml.

0 stars
1 dependent
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  icon-octicons:
    github: kojix2/icon-octicons
    branch: main

main is a branch, not a release, so this tracks it rather than pinning a version.

Then run:

shards install

shard.yml

Crystal
>= 1.22.0
License
MIT
Author
kojix2

Dependencies

Runtime Dependencies

README

icon-octicons

Octicons as 774 pre-rendered CrImage constants for Crystal. Icons retain their source dimensions, including non-square logos.

dependencies:
  icon-octicons:
    github: kojix2/icon-octicons
require "icon-octicons"

icon = Icon::Octicons::Heart16

Names follow the SVG filenames. Use require "icon-octicons/16" to load only one size. PNG data lives in src/data/*.tsv and is loaded by a Crystal macro. Constants are shared, mutable images; copy before editing.

Regenerate

Requires Python 3, librsvg, Cairo, and an upstream ZIP from the project linked above.

python3 scripts/generate.py /path/to/octicons.zip
python3 scripts/generate.py /path/to/octicons.zip --check

If upstream adds a new size, add its src/<size>.cr wrapper and require it from src/icon-octicons.cr.

MIT: shard, upstream icons.

Documentation

Read the API docs

Built from the current release. The first visit to a release nobody has asked for starts its build.

Links

This branch

Branch
main
Seen
Oct 22, 2026
Crystal
>= 1.22.0
Indexed
yes

Dependents

Repository

github.com/kojix2/icon-octicons

Metadata

Created
Oct 24, 2026
Updated
Nov 8, 2026
Synced
Nov 8, 2026
Versions
1