https://github.com/mochaap/hugo-shortcode-mdi

Add Material Design Icons to your Hugo site ✨
https://github.com/mochaap/hugo-shortcode-mdi

Last synced: about 2 months ago
JSON representation

Add Material Design Icons to your Hugo site ✨

• Host: GitHub
• URL: https://github.com/mochaap/hugo-shortcode-mdi
• Owner: mochaaP
• License: mit
• Created: 2020-06-24T18:43:04.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-12-15T05:43:28.000Z (about 1 year ago)
• Last Synced: 2023-12-15T06:47:50.072Z (about 1 year ago)
• Language: HTML
• Size: 5.86 KB
• Stars: 0
• Watchers: 0
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Hugo Material Design Icons Shortcode

Add Material Design Icons to your Hugo site ✨

Light, fast, without an huge iconfont.

## Installation

```bash

# In your Hugo site folder

# First, clone the theme into your Hugo site:

git clone https://github.com/mochaaP/hugo-shortcode-mdi themes/mdi

# Add Git submodule to your site so that you can keep icons up-to-date

git submodule add https://github.com/mochaaP/hugo-shortcode-mdi themes/mdi

# Then fetch the icons from npm (Do this in themes/mdi)

yarn

# or `npm install`

```

Change your first theme to `"mdi"` (toml in example):

```toml

theme = ["mdi", "theme", "another-theme"]

```

You are all set!

To update the icons, do `yarn` again.

## Usage

Just put `{{% mdi [icon] %}}` in your document and it will magically works!

## License

MIT. See `LICENSE` for more details.

Material Design Icons belongs to [@Templarian](https://github.com/templarian/) and Google, licensed under SIL.