MaterialOS Toolkit

Description

A set of tools for maintaining the materialos/icons repository mainly written in Node.js. These aren't required to use our icons but my be helpful for contributors. They may be buggy and will change and break frequently since they're just small tools for internal use.

Features

• Change, parse, and retrieve XMP data by path or tag
• Convert files to SVG using Inkscape
• Make JSON representing the file structure
• Manage all-contributors files
• Minify SVGs
• Render SVGs to PNG
• Retrieve thumbnails from XMP

Installation

From source

$ git clone https://github.com/materialos/toolkit
$ cd toolkit/
$ npm install -g

Usage

CLI

The CLI may be used interactively or using parsed commands from the execution from the shell. You can call --help on commands to learn more about them.

Interactive

$ toolkit
materialos/toolkit: help

From Shell

$ toolkit help
$ toolkit help render # or another command

API

The API for each submodule isn't documented at this time since the API isn't guaranteed to stay the same however, the API can be relatively easily figured out from the parameters of each module's module.exports. Almost every one returns a promise and many save files.

Contributors

Thanks goes to these wonderful people (emoji key):

Daniel Hickman 💻 🎨 📖

This project follows the all-contributors specification. Contributions of any kind welcome!

License

Copyright MaterialOS, MIT License