[Project's Demo Page](https://jossef.github.io/material-design-icons-iconfont)
## MDI**DX** - Same Material Design icons, Better DX
MDI**DX** (this repository) is a ~*fork* (+ fixes) of Google's [Material Design icons](https://github.com/google/material-design-icons) repository.
Sadly, Google allocates **low maintenance and low support** for issues reported by software developers having trouble using the Material Design icons library.
MDI**DX** helps modern **web developers** to use and include the (awesome) Material Design icons library in their project.
### Installation
using bower
```
bower install material-design-icons-iconfont --save
```
using npm
```
npm install material-design-icons-iconfont --save
```
### Usage - Check out the [Demo Page](https://jossef.github.io/material-design-icons-iconfont)
- Using `bower`
bower IMO is the simplest way to use this project
Add this inside your ``
Later on, reference your desired icon `` + icon-id + ``. For instance:
contact_support
Visit the [Demo Page](https://jossef.github.io/material-design-icons-iconfont) for the full icons list
- Using `scss`
Import fonts and variables in your project
```scss
$material-design-icons-font-path: '~material-design-icons-iconfont/dist/fonts/';
@import '~material-design-icons-iconfont/src/material-design-icons';
```
**Customize your own classes**
access material variable with Sass mixins:
```scss
.my-face {
@include material-icon('face');
}
# or
.my-face:before {
content: material-icons-content('face');
}
```
### What's the difference? Why forking?
- **Performance** -
When you checkout Google's [original repository](https://github.com/google/material-design-icons) ( via git, npm and bower) you experience an unwanted delay. This **checkout delay** is caused by **thousands** of separate source graphic `svg,png,...` files.
Needless to say that these file are **irrelevant** for the average developer's purposes and **cause build congestion** (especially when using in CI systems)
In this fork all irrelevant files have been **removed** while keeping only the required files.
- **SCSS Support** - Modern developers need support for `scss`. You can customize the referenced font's files filename and path
- **Maintenance** - The original repository's release has **missing icons** that should be included according to [https://material.io/tools/icons](https://material.io/tools/icons)
### [Demo Page](https://jossef.github.io/material-design-icons-iconfont)
### How to contribute to this project
**Configure environment**
Install nodejs on your environemt (> 7.6 for async await)
**running build**
```
npm install
npm run build
```