VSinerva/freesewing
1
0
Fork 0
Code Activity

fix(docs): Update plugins documentation

Browse source
This commit is contained in:
Benjamin F 2022-12-13 04:39:07 -08:00
parent 7063d8ab9f
commit 767d835cc6
23 changed files with 272 additions and 51 deletions
Download patch file Download diff file Expand all files Collapse all files

18
markdown/dev/reference/plugins/versionfree-svg/en.md
View file

@ -1,11 +1,13 @@
---
title: versionfree-svg
title: plugin-versionfree-svg
---
Published as [@freesewing/plugin-versionfree-svg][1], this plugin suppresses
the inclusion of the FreeSewing version number in SVG output. This allows
diffing pattern output between versions to check for any differences in the
output between different versions of FreeSewing.
the inclusion of the FreeSewing version number in SVG output.
This allows you to more easily check for differences in the
output of different pattern versions of the same design.
Without the plugin, false positives could be seen simply due to
differing FreeSewing version numbers.
## Installation
@ -19,5 +21,11 @@ Either [add it as a part plugins](/reference/api/part/config/plugins) in your
design, or [add it to a pattern instance with
Pattern.use()](/reference/api/pattern/use).
[1]: https://www.npmjs.com/package/@freesewing/plugin-versionfree-svg
To import the plugin for use:
```js
import { versionfreeSvgPlugin } from '@freesewing/plugin-versionfree-svg'
// or
import { pluginVersionfreeSvg } from '@freesewing/plugin-versionfree-svg'
```
[1]: https://www.npmjs.com/package/@freesewing/plugin-versionfree-svg