octicons-html/README.md

Octicons helper for HTML

## Octicons HTML
Octicons helper for HTML.

## [Demo](https://codepen.io/_nK/pen/WBzXrr)

## Getting Started

```html
<link type="text/css" rel="stylesheet" href="octicons-html/dist/octicons-html.css">
<script src="octicons-html/dist/octicons-html.min.js"></script>
```

#### CDN
Link directly from [unpkg](https://unpkg.com/)
```html
<link type="text/css" rel="stylesheet" href="https://unpkg.com/octicons-html@1/dist/octicons-html.css">
<script src="https://unpkg.com/octicons-html@1/dist/octicons-html.min.js"></script>
```

## Call the plugin

Icons will be automatically converted to SVG. Full list of available icons you can find here - [https://octicons.github.com/](https://octicons.github.com/)

```html
<span data-octicon="alert"></span>
```

## For Developers

### Installation
* Run `npm install` in the command line. Or if you need to update some dependencies, run `npm update`

### Building
* `npm run build` to run build

### Linting
* `npm run js-lint` to show eslint errors
* `npm run js-lint-fix` to automatically fix some of the eslint errors