Skip to content

Latest commit

 

History

History
101 lines (62 loc) · 3.72 KB

readme.md

File metadata and controls

101 lines (62 loc) · 3.72 KB
Raw

Sitecore Icons

This repository makes possible usage FA and MUI icons for your Sitecore items

image

You will get 1800+ FA and 2500+ MUI icons X 4 colors (Black, Blue, Green, Red)

How to install

  1. Go to releases
  2. Download latest release package
  3. Login to Sitecore Desktop
  4. Open Development Tools > Installation Wizard
  5. Upload package that you have downloaded
  6. Install it

Packages List

  1. SitecoreIcons-FontAwesome - Font Awesome icons in 4 colors: black, blue, green, red
  2. SitecoreIcons-FontAwesome-Black - Font Awesome icons in black color
  3. SitecoreIcons-FontAwesome-Blue - Font Awesome icons in blue color
  4. SitecoreIcons-FontAwesome-Green - Font Awesome icons in green color
  5. SitecoreIcons-FontAwesome-Red - Font Awesome icons in red color
  6. SitecoreIcons-Full - Font Awesome icons and MUI icons in 4 colors: black, blue, green, red
  7. SitecoreIcons-MUI - MUI Icons in 4 colors: black, blue, green, red
  8. SitecoreIcons-MUI-Black - MUI Icons in black color
  9. SitecoreIcons-MUI-Blue - MUI Icons in blue color
  10. SitecoreIcons-MUI-Green - MUI Icons in green color
  11. SitecoreIcons-MUI-Red - MUI Icons in red color

How packages are built

  1. FA (https://github.com/FortAwesome/Font-Awesome.git) is clonned as submodule
  2. MUI (https://github.com/mui/material-ui.git) is clonned as submodule
  3. We iterate trought all SVG files
  4. We iterate thought all colors
  5. We iterate thought all required sizes (16x16, 24x24, 32x32, 48x48, 128x128)
  6. SVG is modified to have required size and color
  7. SVG is converted to PNG using ImageMagick

FAQ

  1. Q: I have installed packages, but you don't see icons

    A: Try to clean up \Website\temp folder on you CM server

  2. Q: I don't like color shades, I want to change them

    A: Open /scripts/Generic.ps1 and change $colors variable

  3. Q: I want to add more colors or replace existing

    A: Open /scripts/Generic.ps1 and change $colors variable. Open SitecoreIcons.sln in VS and configure colors that you need

  4. Q: Can I trust package content?

    A: All packages are build using GitHub actions and you can review whole process.

  5. Q: Do icons license allow their usage?

    A: Yes. FA has CC By 4.0 License. MUI has MIT License.

  6. Q: I want to change and build packages by myself

    A: You need to fork repository and create tag in format v..... It will trigger new build.

  7. Q: I want to build pakages locally

    A: Run ./scripts/local.ps1 using Powershell

  8. Q: How many icons will I get?

    A: 1800+ FA icons + 2500+ MUI icons

  9. Q: I don't want to have all colors

    A: You may to install only packages with colors that you need

  10. Q: Icons dialog is too slow

    A: It is slow only the first time. Sitecore will make a cache, located in \Website\temp. If cache is cleared then it will take to load long time again.

  11. Q: I want to use it will Docker

    A: No problem, but you need to map \Website\temp folder to avoid rebuild icons cache on each container restart

Licenses

  1. MUI Icons: MIT License
  2. FA Icons: CC By 4.0 License
  3. This repository: MIT License

Thanks to

  1. Viet Hoang, who wrote article about icons many years ago.
  2. MUI authors
  3. FA authors