GithubHelp home page GithubHelp logo

xtoolkit / micon Goto Github PK

View Code? Open in Web Editor NEW
199.0 19.0 31.0 7.75 MB

Micon, The iconic windows 10 font and CSS toolkit.

Home Page: http://xtoolkit.github.io/Micon/

License: MIT License

JavaScript 16.93% HTML 9.66% CSS 73.41%
icons font custom-fonts font-tooklit iconic-toolkit micon bower css

micon's Introduction

Micon Build Status

Micon (MDL2 Icons), The iconic windows 10 font and CSS toolkit.
this icon exracted as segmdl2.ttf in windows 10 and converted too css toolkit based on Font Awesome. Micon icons that can instantly be customized -- size, color, drop shadow, and anything that can be done with the power of CSS.

Online Demo and Documents: http://xtoolkit.github.io/Micon/ (Because i am very busy, online Documents not updated for bower and building)

sry for my bad english

Installation

Quick option: use cdn

You can use cdn. hosted by github page and clouded by Cloudflare example:

<head>
...
<link rel="stylesheet" href="http://cdn.arshen.ir/micon/3.0.168/dist/micon/css/micon.min.css">
...
</head>

Option one: install with bower

To install via Bower, simply do the following:

$ bower install micon --save

Option two: Download repo or builded font

Download last Micon version release from Github

Get started

1- Copy the entire micon-repo/dist/micon/ directory into your project. if you do not use webbrand icon in font, use micon-repo/dist/micon_nb/

2- In the <head> of your html, reference the location to your micon.min.css.
example:

<head>
...
<link rel="stylesheet" href="micon-repo/dist/micon/css/micon.min.css">
...
</head>

use icons in html

example:

<i class="mi mi-Home"></i>
OR
<i class="mi">&#xEC15;</i>

Build Instructions (for make custom font)

This repo already comes with all the files built and ready to go, but can also build the fonts from the source. Requires nodeJs.

Follow these steps to build custom font:

1- install requires Dependencies (gulp, gulp-consolidate, gulp-iconfont, gulp-rename, mustache) with down command.

$ npm install

2- customize your icons from /icons/.
if add new icon, insert icon name in db.json.
example:

{
    ...,
    "svgfilename": {
        "info": {
            "created": "1.0.155" //font-version
        },
        "alias": [
            "aliasname1",
            "aliasname2"
        ]
    }
}

3- customize config.json for your font.

4- customize your scss, less and css template in .templates/. (default use Font-Awesome template Edited by Micon)

5- build your font with down command

$ npm start

6- end, you can see demo your font in /dist/your_fontname/html-demo-your_fontname.html

Page Build Instructions (for make custom your font page)

you can build custom your font page (like Micon github page) with this Instructions

Versioning

Micon will be maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered with the following format:

<major>.<minor>.<fpatch>

And constructed with the following guidelines:

  • major -> Breaking backward compatibility bumps the major
  • minor -> Bug fixes, New additions
  • fpatch -> Version of segmdl2.ttf

For more information on SemVer, please visit http://semver.org.

Next version

We are thinking of supporting react and vuejs

Change Logs

Version 3.0.168 (14/01/2019)

  • update mdl2 icons version => 168 (October 2018)
    • 350 new icon (35 icon untitled)
    • svg icons get larger
  • update webbrand icons (268 new icon)
  • remove classic create font css
  • use scss compiler for create font css
  • remove sourcemap by default
  • change lodash with mustache
  • update scss and less template to Font-Awesome 5.6.3
  • rename fontname.(scss|less) file to style.(scss|less)
  • move font config from gulpfile.js to config.json file in root
  • icons name db file move to icons pack directory (db.json)
  • rewrite gulpfile.js

Version 2.2.155 (05/01/2017)

  • fix #13 issues
  • fix less compile problem
  • add sourcemap for micon and micon_nb

Version 2.1.155 (29/12/2016)

  • support bower
  • add scss and less template
  • move templates to .templates
  • fix style.css problem

Version 2.0.155 (23/12/2016)

  • add GulpJs for build Micon or Easy create custom font fork Micon icons
  • add webBrand icons
  • add woff2 and otf standard font
  • add html-demo-micon.html for simple portable view icons.
  • update style template
  • fix alias name problem
  • fix some font view probrom (etc height of icons)

Version 1.0.155 (16/08/2016)

  • update icons version => 155 (RedStone)
  • rename icons name with official MDL2 icons name
  • remove woff2 and otf font
  • fixed icon animation problem
  • fixed icon height problem
  • create Change logs page

Version 0.9.136 (12/09/2015)

  • initial build
  • remove duplicate svg path and use css alias

License

Micon is licensed under the MIT license.

Contact

E-mail: [email protected]
Telegram: @Arshen

micon's People

Contributors

xtoolkit avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

micon's Issues

License

Are you sure that you can use MIT license for this icons (or use this font at all) ?
From the Segoe MDL2 icons article https://msdn.microsoft.com/windows/uwp/style/segoe-ui-symbol-font
How do I get this font?
To obtain Segoe MDL2 Assets, you must install Windows 10.

and the first question from https://www.microsoft.com/typography/faq/faq11.htm
What can I do with the fonts supplied with Microsoft products?
The fonts are governed by the same restrictions as the products they are supplied with. You are not allowed to copy, redistribute or reverse engineer the font files. For full details see the license agreement supplied with the product.

Sass not working

Hi,

really like your Icons! I want to use the sass files but I got a problem. I only see square instead of the icons.

I changed the font-path to

 $mi-font-path:        "../fonts/" !default;

The fonts are in my public folder under fonts and my compiled css is in the public folder, too.

Do you have any idea?

Failed to decode

I made import in my vuejs project:
image

but, when i will test in browser im getting this error :
image

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.