CONTRIBUTING.md

Contribution Guides

Development

Install Dependencies

Clone the repo and install dependencies:

yarn

Icons

Fetch icon sources:

yarn download -f

This script would download icon packs as zip files from their Github repositories. Although it could be achieved more easily via "git submodule", too many submodules brings git too much loads and reduces its speed.

Then, re-generate files under package/icons automatically:

yarn icons

Dev

yarn dev

Build

yarn build

 

Website

The source code of the website is under folder docs, built with Vitesse.

Start developing:

yarn docs

Generate static files:

yarn build:docs

 

License

By contributing to oh-vue-icons, you agree that your contributions will be licensed under its MIT license.