open-index/open-npm huggingface dataset:
npm package: @icon/open-iconic
Description: An open source icon set with marks in SVG, sprite, webfont and raster format
Author: Iconic
Latest version: 1.1.1-alpha.3

# @icon/open-iconic

[![npm version](https://img.shields.io/npm/v/@icon/open-iconic.svg)](https://www.npmjs.org/package/@icon/open-iconic)

This repository is a module of the full [standard-icons][standard-icons] repository.

## Install

This repository is distributed with [npm]. After [installing npm][install-npm], you can install `@icon/open-iconic` with this command.

```bash
npm install --save @icon/open-iconic
```

## Usage

There are many ways/formats of how to use open-iconic. The fastest and recommended way is via SVG directly. Or use the webfont version if you want to include all icons at once:

### SVG icons -- when you need just a few icons in your project

1 . If you want to use just a few icons. Find the icons you need in "icons" folder. Then use them as regular images:

```
<img height="32" width="32" src="@icon/open-iconic/icons/account-login.svg" />
```

2 . Icons can be served from a CDN such as [Unpkg][Unpkg]. Simply use the `@icon/open-iconic` npm package in the URL like the following:

```
<img height="32" width="32" src="https://unpkg.com/@icon/open-iconic/icons/account-login.svg" />
```

### Icons font -- ideal when you want to include all icons at once

1 . Install `@icon/open-iconic` with this command. In the `<head>` of your html, reference the location to your `open-iconic.css`.

```
<head>
...
<link rel="stylesheet" href="@icon/open-iconic/open-iconic.css">
...
</head>
```

2 . Use [unpkg.com][Unpkg] to load directly open-iconic without installing anything:

```
<head>
...
<link rel="stylesheet" href="https://unpkg.com/@icon/open-iconic/open-iconic.css">
...
</head>
```

> Place open-iconic with `<i>` tag in your html like this. Icon class names are to be used with the `oi` class prefix.

```
<i class="oi oi-account-login"></i>
```


## Bugs, Ideas, Pull Requests

If you have any ideas or found bugs, please send me Pull Requests or let me know with [GitHub Issues][github issues].

## License

Open-iconic is copyright by Iconic, licensed under the [MIT][license].

[license]: https://opensource.org/licenses/MIT
[standard-icons]: https://github.com/thecreation/standard-icons
[npm]: https://www.npmjs.com/
[install-npm]: https://docs.npmjs.com/getting-started/installing-node
[sass]: http://sass-lang.com/
[github issues]: https://github.com/thecreation/standard-icons/issues
[Unpkg]: https://unpkg.com