update docs (#183)

johnkenny54 · web-flow · commit d709619df5ef · 2026-01-20T16:02:38.000-08:00
diff --git a/docs/02-usage/02-browser.mdx b/docs/02-usage/02-browser.mdx
diff --git a/docs/diffs-from-svgo.md b/docs/diffs-from-svgo.md
@@ -8,37 +8,9 @@ In SVGO, rounding of decimal values is enabled by default and integrated into ma
 
 ## Plugins
 
-The following SVGO default plugins have been removed from **svgo-ll**:
-
-- **cleanupAttrs**
-- **cleanupEnableBackground**
-- **cleanupNumericValues**
-- **convertColors** - similar functionality is in the new **[minifyColors](./plugins/minifyColors.md)** plugin
-- **convertPathData** - most of the lossless functionality of this plugin has been preserved in the new **[minifyPathData](./plugins/minifyPathData.md)** plugin
-- **convertTransform** - some of the benefits of this plugin are achieved with the new **[minifyTransforms](./plugins/minifyTransforms.md)** plugin
-- **mergePaths** - some of the benefits of **mergePaths** are achieved with the new **[createGroups](./plugins/createGroups.md)** plugin
-- **mergeStyles**
-- **moveElemsAttrsToGroup**
-- **moveGroupAttrsToElems**
-- **removeDeprecatedAttrs**
-- **removeEmptyAttrs**
-- **removeEmptyText** - now handled by [removeEmptyContainers](./plugins/removeEmptyContainers.md)
-- **sortAttrs**
-- **sortDefsChildren**
-
-The following new default plugins have been added to **svgo-ll**:
-
-- **[cleanupStyleAttributes](./plugins/cleanupStyleAttributes.md)**
-- **[cleanupTextElements](./plugins/cleanupTextElements.md)**
-- **[cleanupXlink](./plugins/cleanupXlink.md)**
-- **combineStyleElements**
-- **[createGroups](./plugins/createGroups.md)**
-- **[mergeGradients](./plugins/mergeGradients.md)**
-- **[minifyColors](./plugins/minifyColors.md)**
-- **[minifyGradients](./plugins/minifyGradients.md)**
-- **[minifyPathData](./plugins/minifyPathData.md)**
-- **[minifyTransforms](./plugins/minifyTransforms.md)**
-- **moveElemsStylesToGroup**
+Many plugins have been removed or rewritten, and new plugins have been added.
+
+See the list of [default plugins](./plugins/default-plugins.md) for information about **svgo-ll** plugins.
 
 ## CSS
 
@@ -50,6 +22,8 @@ Plugins can be [enabled, disabled, and configured](./command-line-options.md#plu
 
 The `--multipass` option has been removed and replaced by [`--max-passes`](./command-line-options.md#max-passes). By default **svgo-ll** will make up to 10 passes, the equivalent of using the `--multipass` option in SVGO.
 
+A preprocessing phase (plugins are run once each, before the main plugin loop) and a postprocessing phase (plugins are run once each, after the main plugin loop).
+
 <a id="scalability"></a>
 
 ## Scalability
diff --git a/docs/faq.md b/docs/faq.md
@@ -37,7 +37,7 @@ npx svgo-ll --plugins minifyPathData -i test.svg
 Use the `--disable` command line option. For example:
 
 ```
-npx svgo-ll --disable minifyPathData cleanupIds -i test.svg
+npx svgo-ll --disable minifyPathData minifyIds -i test.svg
 ```
 
 <a id="comp-round"></a>
@@ -54,11 +54,11 @@ npx svgo-ll -i test.svg --enable round
 
 ### Change the default options for a plugin
 
-You can change the default options for a plugin by creating a JSON file and using the [`--options` command line option](./command-line-options.md#options). For example, to use the default plugins and specify an id that should not be changed by the `cleanupIds` plugin, create file named `options.json` with the content:
+You can change the default options for a plugin by creating a JSON file and using the [`--options` command line option](./command-line-options.md#options). For example, to use the default plugins and specify an id that should not be changed by the `minifyIds` plugin, create a file named `options.json` with the content:
 
 ```
 {
-  "cleanupIds": {
+  "minifyIds": {
     "preserve": "abc"
   }
 }
diff --git a/docs/plugins/cleanupGradientAttributes.md b/docs/plugins/cleanupGradientAttributes.md
@@ -0,0 +1,17 @@
+# cleanupGradientAttributes
+
+Removes unnecessary `<linearGradient>` and `<radialGradient>` attributes.
+
+## Details
+
+The plugin has no effect if:
+
+- The document has scripts.
+- The document has `<style>` elements.
+
+The plugin does the following:
+
+- If `gradientUnits="userSpaceOnUse"`, converts to `objectBoundingBox` if possible, and adjust the values of other attributes.
+- Applies the `gradientTransform` directly to the coordinates if possible.
+- Removes attributes which are not needed because they are default values.
+- Removes attributes which are not needed because they are always overridden.
diff --git a/docs/plugins/cleanupIds.md b/docs/plugins/cleanupIds.md
diff --git a/docs/plugins/convertImageToUse.md b/docs/plugins/convertImageToUse.md
@@ -0,0 +1,16 @@
+# convertImageToUse
+
+Convert duplicate `<image>` elements to `<use>` elements.
+
+## Details
+
+The plugin has no effect if:
+
+- The document has scripts.
+- The document has `<style>` elements.
+
+This plugin does the following:
+
+- For `<image>` elements with identical `data` URLs in their `href` attribute
+  - creates a single `<image>` in a `<defs>` element
+  - converts the original `<image>` elements to `<use>` elements referencing the common image
diff --git a/docs/plugins/default-plugins.md b/docs/plugins/default-plugins.md
@@ -27,19 +27,21 @@ Run until there are no further decreases in size, up to [max-passes](../command-
 
 - [inlineStyles](./inlineStyles.md)
 - minifyStyles
-- [cleanupIds](./cleanupIds.md)
 - [minifyColors](./minifyColors.md)
-- [minifyGradients](./minifyGradients.md)
 - [removeUnknownsAndDefaults](./removeUnknownsAndDefaults.md)
 - removeNonInheritableGroupAttrs
+- [removeUselessProperties](./removeUselessProperties.md)
+- [removeUnusedElements](./removeUnusedElements.md)
 - [removeUselessStrokeAndFill](./removeUselessStrokeAndFill.md)
-- [removeHiddenElems](./removeHiddenElems.md)
-- [mergeDefs](./mergeDefs.md)
 - convertEllipseToCircle
 - moveElemsStylesToGroup
+- [cleanupGradientAttributes](./cleanupGradientAttributes.md)
 - [convertShapeToPath](./convertShapeToPath.md)
 - [minifyPathData](./minifyPathData.md)
+- [mergeFilters](./mergeFilters.md)
 - [mergeGradients](./mergeGradients.md)
+- [minifyGradients](./minifyGradients.md)
+- [minifyPatterns](./minifyPatterns.md)
 - [removeEmptyContainers](./removeEmptyContainers.md)
 - [convertPathToUse](./convertPathToUse.md)
 - [createGroups](./createGroups.md)
@@ -53,6 +55,8 @@ Run until there are no further decreases in size, up to [max-passes](../command-
 Run once, in the specified order, after main plugins have completed:
 
 - removeUnusedNS
+- [convertImageToUse](./convertImageToUse.md)
+- [moveGradientAttsToTemplate](./moveGradientAttsToTemplate.md)
 - [minifyIds](./minifyIds.md)
 - [minifyAttrsAndStyles](./minifyAttrsAndStyles.md)
 - [stylesToClasses](./stylesToClasses.md)
diff --git a/docs/plugins/mergeDefs.md b/docs/plugins/mergeDefs.md
diff --git a/docs/plugins/mergeFilters.md b/docs/plugins/mergeFilters.md
@@ -0,0 +1,12 @@
+# mergeFilters
+
+Combines identical `<filter>` elements and removes duplicates.
+
+## Details
+
+The plugin has no effect if:
+
+- The document has scripts.
+- The document has `<style>` elements with CSS which **svgo-ll** is not able to process.
+
+Duplicate `<filter>` elements are removed, and references to the removed elements are updated to reference the single remaining `<filter>` element.
diff --git a/docs/plugins/minifyGradients.md b/docs/plugins/minifyGradients.md
@@ -11,6 +11,7 @@ The plugin has no effect if:
 
 This plugin makes the following transformations:
 
+- Unnecessary stop elements are removed.
 - `stop` attributes are written in the shortest format (for example, `"90%"` becomes `".9"`).
 - If a gradient consists of a single solid color, any references to the gradient are changed to use the color itself.
 - If a gradient is used as a [template](https://svgwg.org/svg2-draft/pservers.html#PaintServerTemplates) and is only referenced once, the template is merged with the referencing gradient.
diff --git a/docs/plugins/minifyPatterns.md b/docs/plugins/minifyPatterns.md
@@ -0,0 +1,17 @@
+# minifyPatterns
+
+Combines `<pattern>` elements and removes unused attributes.
+
+## Details
+
+The plugin has no effect if:
+
+- The document has scripts.
+- The document has `<style>` elements with CSS which **svgo-ll** is not able to process.
+
+The plugin does the following:
+
+- Merges template patterns which are only referenced once into the referencing `<pattern>`.
+- Eliminates duplicate patterns.
+- Removes attributes in template patterns which are not used.
+- Removes patterns with an invalid `href` attribute.
diff --git a/docs/plugins/moveGradientAttsToTemplate.md b/docs/plugins/moveGradientAttsToTemplate.md
@@ -0,0 +1,11 @@
+# moveGradientAttsToTemplate
+
+Moves gradient attributes to templates.
+
+## Details
+
+The plugin has no effect if:
+
+- The document has scripts.
+
+If a gradient element is only used as a template, any common attributes in the referencing gradients are moved to the template.
diff --git a/docs/plugins/removeHiddenElems.md b/docs/plugins/removeHiddenElems.md
diff --git a/docs/plugins/removeUnusedElements.md b/docs/plugins/removeUnusedElements.md
@@ -0,0 +1,33 @@
+# removeUnusedElements
+
+Removes unrendered elements.
+
+## Details
+
+The plugin has no effect if:
+
+- The document has scripts.
+- The document has `<style>` elements with CSS which **svgo-ll** is not able to process.
+- The document has selectors other than class, id, or element name selectors.
+
+The following elements are removed:
+
+- Those where `display` is `none`.
+- Those where `opacity` is `0` and which are not otherwise referenced.
+- `<circle>` or `<ellipse>` elements where radius is `0`.
+- `<rect>` elements where `width` or `height` is `0`.
+- `<clipPath>` elements with no visible content, along with an elements whose `clip-path` references them.
+- `<linearGradient>` elements that reference a non-existent template.
+- `<use>` elements which that reference a non-existent element.
+- Those with no `id` which are not displayed and not otherwise referenced.
+
+The following attributes are modified:
+
+- `fill` or `stroke` that references a non-existent paint server is changed to `none`.
+- `id` attributes which are not referenced are removed.
+
+Additional actions:
+
+- Some elements that are not directly referenced or displayed, but contain referenced content, are converted to `<defs>`.
+- Some elements that are not directly referenced or displayed, but contain referenced content, are removed, and there referenced children are made direct children of a `<defs>` element.
+- All `<defs>` elements are combined into a single element.
diff --git a/docs/plugins/removeUselessProperties.md b/docs/plugins/removeUselessProperties.md
@@ -0,0 +1,15 @@
+# removeUselessProperties
+
+Removes attributes and properties that are not used.
+
+## Details
+
+The plugin has no effect if:
+
+- The document has scripts.
+- The document has `<style>` elements with CSS which **svgo-ll** is not able to process.
+
+The following attributes and properties are removed:
+
+- Presentation properties are removed from shape elements that are not displayed (e.g., those only used to define a `<clipPath>`).
+- Identity transforms are removed unless they override another transform.
diff --git a/lib/version.js b/lib/version.js
@@ -1,2 +1,2 @@
 /** Version of SVGO. */
-export const VERSION = '6.3.0-alpha.1';
+export const VERSION = '6.3.0';
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "svgo-ll",
-  "packageManager": "npm@11.6.2",
-  "version": "6.3.0-alpha.1",
+  "packageManager": "npm@11.7.0",
+  "version": "6.3.0",
   "description": "svgo-ll is a Node.js library and command-line application for optimizing SVG images.",
   "license": "MIT",
   "type": "module",
diff --git a/test/plugins/removeUnusedElements.59.svg.txt b/test/plugins/removeUnusedElements.59.svg.txt

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ npx svgo-ll --plugins minifyPathData -i test.svg`
`37`	`37`	Use the `--disable` command line option. For example:
`38`	`38`
`39`	`39`	```
`40`		`-npx svgo-ll --disable minifyPathData cleanupIds -i test.svg`
	`40`	`+npx svgo-ll --disable minifyPathData minifyIds -i test.svg`
`41`	`41`	```
`42`	`42`
`43`	`43`	`<a id="comp-round"></a>`
`@@ -54,11 +54,11 @@ npx svgo-ll -i test.svg --enable round`
`54`	`54`
`55`	`55`	`### Change the default options for a plugin`
`56`	`56`
`57`		-You can change the default options for a plugin by creating a JSON file and using the [`--options` command line option](./command-line-options.md#options). For example, to use the default plugins and specify an id that should not be changed by the `cleanupIds` plugin, create file named `options.json` with the content:
	`57`	+You can change the default options for a plugin by creating a JSON file and using the [`--options` command line option](./command-line-options.md#options). For example, to use the default plugins and specify an id that should not be changed by the `minifyIds` plugin, create a file named `options.json` with the content:
`58`	`58`
`59`	`59`	```
`60`	`60`	`{`
`61`		`- "cleanupIds": {`
	`61`	`+ "minifyIds": {`
`62`	`62`	`"preserve": "abc"`
`63`	`63`	`}`
`64`	`64`	`}`