{"id":15630494,"url":"https://github.com/glaszig/compass-fontcustom","last_synced_at":"2025-04-29T11:57:16.125Z","repository":{"id":7464555,"uuid":"8811293","full_name":"glaszig/compass-fontcustom","owner":"glaszig","description":"Font Custom integration with Compass","archived":false,"fork":false,"pushed_at":"2017-01-31T22:20:03.000Z","size":108,"stargazers_count":18,"open_issues_count":0,"forks_count":10,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-29T11:56:55.747Z","etag":null,"topics":["compass","css","fontcustom","ruby"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/glaszig.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-03-15T23:42:44.000Z","updated_at":"2020-02-16T07:57:41.000Z","dependencies_parsed_at":"2022-09-01T16:40:45.285Z","dependency_job_id":null,"html_url":"https://github.com/glaszig/compass-fontcustom","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glaszig%2Fcompass-fontcustom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glaszig%2Fcompass-fontcustom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glaszig%2Fcompass-fontcustom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glaszig%2Fcompass-fontcustom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/glaszig","download_url":"https://codeload.github.com/glaszig/compass-fontcustom/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251498965,"owners_count":21598979,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["compass","css","fontcustom","ruby"],"created_at":"2024-10-03T10:33:01.421Z","updated_at":"2025-04-29T11:57:16.101Z","avatar_url":"https://github.com/glaszig.png","language":"Ruby","readme":"# Compass::Fontcustom\n\n[![Build Status](https://travis-ci.org/glaszig/compass-fontcustom.png?branch=master)](https://travis-ci.org/glaszig/compass-fontcustom)\n[![Gem Version](https://badge.fury.io/rb/compass-fontcustom.png)](http://badge.fury.io/rb/compass-fontcustom)\n[![Test Coverage](https://coveralls.io/repos/glaszig/compass-fontcustom/badge.png?branch=master)](https://coveralls.io/r/glaszig/compass-fontcustom)\n\nThis is my attempt of integrating [Font Custom](http://fontcustom.com) with [Compass](http://compass-style.org).\n\n## Requirements\n\nTested on Ruby 2.0, 2.1, 2.2, 2.3 and 2.4.  \nYou'll need to have fontforge and the [WOFF font toolset](http://people.mozilla.com/~jkew/woff) installed as outlined in the Font Custom [installation instructions](http://fontcustom.com/#installation).\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n    gem 'compass-fontcustom'\n\nor:\n\n    gem 'compass-fontcustom', :github =\u003e 'glaszig/compass-fontcustom'\n\nAnd then execute:\n\n    $ bundle\n\n## Configuration\n\nCompass::Fontcustom adds the following configuration options to Compass.  \nJust add these to your project's `config/compass.rb`.\n\n- `fontcustom_input_paths`  \n  Array of paths where to search for SVG files to build custom fonts from.\n- `fontcustom_discard_manifest`  \n  Boolean to configure to delete the manifest file after each run.\n- `fontcustom_options`  \n  A hash to pass native options to FontCustom.\n\n## Usage\n\nSyntactically it works like Compass' sprites feature.  \nYou can let Font Custom generate your fonts upon Compass' css compilation:\n\n```css\n@import \"myfont/*.svg\";\n@include all-myfont-glyphs;\n```\n\nThis will setup a proper `@font-face` and generate icon classes named `.icon-\u003cfont_name\u003e-\u003cglyph_name\u003e` for each glyph.\n\n### Custom class names\n\nYou can also use custom class names using the `\u003cfont_name\u003e-glyph()` mixin:\n\n```css\n.custom-class-name {\n  @include myfont-glyph(glyph-file-name);\n}\n```\n\nwhich will result into CSS along the lines of:\n\n```css\n.myfont-font, .custom-class-name {\n  font-family: \"myfont\";\n}\n.custom-class-name:before {\n  content: \"\\f100\";\n}\n```\n\n\u003e **Attention**  \n\u003e Generated CSS class names will be normalized and reserved characters removed.  \n\u003e That means if you have a glyph file name of `a_R3ally-eXotic f1Le+Name.svg` the generated class name will be `.icon-myfont-a_R3ally-eXotic-f1Le-Name`.\n\n## Contributing\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n\n## License\n\n[MIT](https://raw.github.com/glaszig/compass-fontcustom/master/LICENSE)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fglaszig%2Fcompass-fontcustom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fglaszig%2Fcompass-fontcustom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fglaszig%2Fcompass-fontcustom/lists"}