Preview

Preview of icons

In order to help you preview how the icon you are contributing will look in the editor, we are providing you with a tool that generates dummy folders or files of the provided icon.

To install the tool, execute the following command inside the vscode-icons project:

npm install vscode-icons/examples-generator --no-save

This will install the tool in the node_modules folder, without saving it in the project's dependencies.

The syntax to run it follows the pattern:

./node_modules/.bin/example <flag> [space-separated icon names]

Supported flags are --all, --folders, --files.

Syntax examples

./node_modules/.bin/example --folders bower css

Hint: By omitting the use of the space-separated folder names, the tool will create examples for all supported folders.

./node_modules/.bin/example --files actionscript angular

Hint: By omitting the use of the space-separated file names, the tool will create examples for all supported files.

./node_modules/.bin/example --all

The above syntax will create examples for all supported files and folders.