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

16
markdown/dev/reference/plugins/measurements/en.md
View file

@ -3,7 +3,7 @@ title: plugin-measurements
---
Published as [@freesewing/plugin-measurements][1], this plugin will
provide a number of extra measurements to your pattern insofar as
provide a number of extra measurements to your design insofar as
they can be deduced from the measurements that are provided.
It will add the following measurements:
@ -14,7 +14,12 @@ It will add the following measurements:
- `waistFront` (if both `waist` and `waistBack` are provided)
- `waistBackArc` (if both `waist` and `waistBack` are provided)
- `waistFrontArc` (if both `waist` and `waistBack` are provided)
- `crossSeamBack` (if both `crossSeam` and `crossSeamFront` are available)
- `crossSeamBack` (if both `crossSeam` and `crossSeamFront` are provided)
<Related compact>
For more information about these extra measurements, please see
[Measurements from `plugin-measurements`](/reference/measurements#measurements-from-plugin-measurements)
</Related>
## Installation
@ -28,6 +33,13 @@ 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).
To import the plugin for use:
```js
import { measurementsPlugin } from '@freesewing/plugin-measurements'
// or
import { pluginMeasurements } from '@freesewing/plugin-measurements'
```
## Notes
The measurements plugin is part of our [plugin-bundle](/reference/plugins/bundle)