# mdi-font-build

> Material Design Icons webfont builder.

Latest version **0.1.2** (published 2020-10-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install mdi-font-build
pnpm add mdi-font-build
yarn add mdi-font-build
bun add mdi-font-build
```

Provides the command `mdi-font-build`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2020-10-27 |
| First published | 2020-10-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 91.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | chuangzhu |
| Maintainers | chuangzhu |

## Links

- npm: https://www.npmjs.com/package/mdi-font-build
- Repository: https://github.com/chuangzhu/mdi-font-build
- npm.io page: https://npm.io/package/mdi-font-build

## Dependencies (5)

- [sass](https://npm.io/package/sass.md) ^1.27.0
- [yargs](https://npm.io/package/yargs.md) ^16.1.0
- [globby](https://npm.io/package/globby.md) ^9.2.0
- [webfont](https://npm.io/package/webfont.md) ^9.0.0
- [@mdi/svg](https://npm.io/package/@mdi/svg.md) ^5.7.55

## Recent versions

- 0.1.2 (latest) — 2020-10-27
- 0.1.1 — 2020-10-26
- 0.1.0 — 2020-10-24

## README

# mdi-font-build

An (maybe) easier to use version of [Templarian/MaterialDesign-Font-Build](https://github.com/Templarian/MaterialDesign-Font-Build/).

```bash
npm i -g mdi-font-build
```

## CLI

```bash
mdi-font-build <iconNames...> -o <outputDirectory> [-e <extraIcons...>]
```

* `iconNames`: Icons to include, e.g. `bell account clock-outline`.
* `extraIcons`: SVG files to include besides the MDI collection.
* `outputDirectory`: Directory to output font and CSS files.

## Node

```javascript
const fontBuild = require('mdi-font-build')
fontBuild(iconNames, extraIcons, outputDirectory)
```

* `iconNames: Array<string>`
* `extraIcons: Array<string>`, shell globs are allowed.
* `outputDirectory: string`

---
_Source: https://npm.io/package/mdi-font-build · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
