Config

svgworm.config.json is optional: every key except sources has a default, and CLI flags can replace the file entirely. It has a JSON Schema, published as svgworm/schema.json:

{
  "$schema": "https://unpkg.com/svgworm/svgworm.schema.json",
  "sources": ["icons"],
  "color": [{ "match": "brand/*", "color": "preserve" }]
}
Key Default Meaning
sources required Folders with the SVG files
outDir public/icons Where sprite files go. Needs publicPath when set
publicPath /icons Same-origin URL path the sprites are served from
moduleDir svgworm Where the manifest and types go
flatten false Drop folder names from icon names
color [] Per-icon overrides. match is a glob on the icon name; color is auto, mono or preserve. The last match wins

Edit this page on GitHub