Skip to content

v.1.0.5
Compare
Choose a tag to compare
@rfprod rfprod released this 22 Jan 18:39
· 6 commits to main since this release
v.1.0.5
f5f7572
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

Self-hosted version generator of Google Material Design icon fonts for web apps

This is NOT a fork of the material design icons by Google, including only the font files for smaller distribution.

This is a generator script which fetches the iconfont from the original material design icons repo, converts otf fonts to woff, and makes it possible to use the self-hosted version of the latest material design icons for web.

Requirements

Supported operating systems

Core dependencies

Local script usage

Clone the repo, cd into the project directory and execute from root

$ bash src/generate-iconfont.sh

Fonts will be generated in the ./iconfont directory relative to the project root.

Material design icons

Material design icons are the official icon set from Google that are designed under the material design guidelines.

Developer guide

Read the developer guide on how to use the material design icons in your project.

Using the font collection (recommended way as per Google)

The iconfont folder contains pre-generated font files that can be included in a project. This is especially convenient for the web. However, it is generally better to link to the web font hosted on Google Fonts:

<link
  href="https://fonts.googleapis.com/icon?family=Material+Icons"
  rel="stylesheet"
/>

Using the self-hosted version

Install the package. Exexute

npm i --save-dev material-design-icon-fonts-self-hosted-web

or

yarn add -D material-design-icon-fonts-self-hosted-web

Angular

Add one of the folowing css files to the styles array of a corresponding app in angular.json depending on which version of the icons are intended to be used in the app.

Regular
"styles": [
  "node_modules/material-design-icon-fonts-self-hosted-web/iconfont/material-icons.css"
],
Outlined
"styles": [
  "node_modules/material-design-icon-fonts-self-hosted-web/iconfont/material-icons-outlined.css"
],
Round
"styles": [
  "node_modules/material-design-icon-fonts-self-hosted-web/iconfont/material-icons-round.css"
],
Sharp
"styles": [
  "node_modules/material-design-icon-fonts-self-hosted-web/iconfont/material-icons-sharp.css"
],
TwoTone
"styles": [
  "node_modules/material-design-icon-fonts-self-hosted-web/iconfont/material-icons-twotone.css"
],

Support

The readme file in the project root contains all needed information regarding working with the project.

If there are any issues, GitHub issues can be leveraged to request support. However, there is no SLA regarding the response time.

Secutiry

Always inspect shell scripts before executing it on your machine.

Assets 2
Loading