A tool for converting GitHub's Octicons into an icon font for VS Code
Перейти к файлу
Miguel Solorio 200bc7b4bb Add instructions for updating npm packages 2019-04-11 10:30:40 -07:00
.vscode Update scripts to create a dev version 2019-01-07 14:03:56 -08:00
src Fix #1, apply rendering modifications 2019-01-07 14:38:48 -08:00
.gitignore Update ignore files 2019-01-03 08:41:56 -08:00
LICENSE Initial commit 2019-01-03 08:36:07 -08:00
README.md Add instructions for updating npm packages 2019-04-11 10:30:40 -07:00
ThirdPartyNotices.txt Create ThirdPartyNotices.txt 2019-01-28 13:10:38 -08:00
package-lock.json Update Octicons to 8.5.0 2019-04-11 10:29:46 -07:00
package.json Update Octicons to 8.5.0 2019-04-11 10:29:46 -07:00

README.md

vscode-octicons-font

Intro

This tool was created to convert GitHub Octicons into an icon font using the icon-font-generator. This also adds a few custom icons from previous versions under src > icons. The mappings of the unicode characters are store under src/template/mapping.json as well as the default styles under src/template/styles.hbs.

Install

npm install

Build

npm run build

Output will be exported to a dist folder. You can alternately run npm run dev that will also generate a preview file.

Update Packages

You can run npm outdated to see if there are any package updates. To update packages, run:

npm update

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.