WebisteDLH/wwwroot/vendor/linea-icons/linea-basic/README.md

76 lines
2.4 KiB
Markdown

# @icon/linea-basic
[![npm version](https://img.shields.io/npm/v/@icon/linea-basic.svg)](https://www.npmjs.org/package/@icon/linea-basic)
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/linea-basic` with this command.
```bash
npm install --save @icon/linea-basic
```
## Usage
There are many ways/formats of how to use linea-basic. 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/linea-basic/icons/basic-book.svg" />
```
2 . Icons can be served from a CDN such as [Unpkg][Unpkg]. Simply use the `@icon/linea-basic` npm package in the URL like the following:
```
<img height="32" width="32" src="https://unpkg.com/@icon/linea-basic/icons/basic-book.svg" />
```
### Icons font -- ideal when you want to include all icons at once
1 . Install `@icon/linea-basic` with this command. In the `<head>` of your html, reference the location to your `linea-basic.css`.
```
<head>
...
<link rel="stylesheet" href="@icon/linea-basic/linea-basic.css">
...
</head>
```
2 . Use [unpkg.com][Unpkg] to load directly linea-basic without installing anything:
```
<head>
...
<link rel="stylesheet" href="https://unpkg.com/@icon/linea-basic/linea-basic.css">
...
</head>
```
> Place linea-basic with `<i>` tag in your html like this. Icon class names are to be used with the `lba` class prefix.
```
<i class="lba lba-basic-book"></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
Linea-basic is copyright by Dario Ferrando, licensed under the [CC0-1.0][license].
[license]: https://github.com/thecreation/icons/blob/master/modules/linea-basic/LICENSE
[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