1
0
Fork 0

chore(markdown): Linting of dev docs

This commit is contained in:
Joost De Cock 2022-02-19 08:04:25 +01:00
parent 1d8beedd44
commit 265ad404da
317 changed files with 1281 additions and 1503 deletions

View file

@ -2,7 +2,7 @@
title: "@freesewing/plugin-banner"
---
The **@freesewing/plugin-banner** plugin provides
The **@freesewing/plugin-banner** plugin provides
[the banner macro](/reference/api/macros/banner).
This macro allows you to add repeating text along a path.
@ -29,7 +29,5 @@ import config from "../config";
const Pattern = new freesewing.Design(config, banner);
```
Now you can use the
Now you can use the
[banner](/reference/api/macros/banner/) macros in your parts.

View file

@ -2,9 +2,9 @@
title: "@freesewing/plugin-bartack"
---
The **@freesewing/plugin-bartack** plugin provides
The **@freesewing/plugin-bartack** plugin provides
[the bartack macro](/reference/api/macros/bartack).
This macro allows you to add bartacks — a set of
This macro allows you to add bartacks — a set of
tight zig-zag stitches used to enforce a seam — to your design.
## Example
@ -30,9 +30,7 @@ import config from "../config";
const Pattern = new freesewing.Design(config, bartack);
```
Now you can use the
[bartack](/reference/api/macros/bartack/),
[bartackAlong](/reference/api/macros/bartackalong/), and
Now you can use the
[bartack](/reference/api/macros/bartack/),
[bartackAlong](/reference/api/macros/bartackalong/), and
[bartackFractionAlong](/reference/api/macros/bartackfractionalong/) macros in your parts.

View file

@ -4,14 +4,14 @@ title: "@freesewing/plugin-bundle"
The **@freesewing/plugin-bundle** plugin bundles the most common FreeSewing build-time plugins:
- [plugin-cutonfold](/reference/plugins/cutonfold) : Add cut-on-fold indicators to your patterns
- [plugin-dimension](/reference/plugins/dimension) : Add dimensions to your (paperless) patterns
- [plugin-grainline](/reference/plugins/grainline) : Add grainline indicators to your patterns
- [plugin-logo](/reference/plugins/logo) : Add a scalebox to your patterns
- [plugin-scalebox](/reference/plugins/scalebox) : Add pretty titles to your pattern parts
- [plugin-title](/reference/plugins/title) : Add pretty titles to your pattern parts
- [plugin-round](/reference/plugins/round) : Rounds corners
- [plugin-sprinkle](/reference/plugins/sprinkle) : Add multiple snippets to your pattern
- [plugin-cutonfold](/reference/plugins/cutonfold) : Add cut-on-fold indicators to your patterns
- [plugin-dimension](/reference/plugins/dimension) : Add dimensions to your (paperless) patterns
- [plugin-grainline](/reference/plugins/grainline) : Add grainline indicators to your patterns
- [plugin-logo](/reference/plugins/logo) : Add a scalebox to your patterns
- [plugin-scalebox](/reference/plugins/scalebox) : Add pretty titles to your pattern parts
- [plugin-title](/reference/plugins/title) : Add pretty titles to your pattern parts
- [plugin-round](/reference/plugins/round) : Rounds corners
- [plugin-sprinkle](/reference/plugins/sprinkle) : Add multiple snippets to your pattern
Almost all patterns use these plugins, so it made sense to bundle them.
@ -33,4 +33,3 @@ import config from "../config";
const Pattern = new freesewing.Design(config, plugins);
```

View file

@ -20,8 +20,8 @@ This is the same technique that's used in a full-bust adjustment to fit a womens
This plugin helps you by:
- Storing the chest circumference in `measurements.bust`
- Changing `measurments.chestCircumference` to the value of `measurements.highBust`
- Storing the chest circumference in `measurements.bust`
- Changing `measurments.chestCircumference` to the value of `measurements.highBust`
</Note>
@ -33,7 +33,7 @@ In this case, the plugin will always be loaded since the pattern assumes breasts
This way you can extend a menswear pattern and have it drafted with the high bust measurement
as chest measurment, after which you can create room for the breasts.
You can see this in practice in our [Carlita][1] pattern,
You can see this in practice in our [Carlita][1] pattern,
which extends the menswear [Carlton][2] pattern.
<Tip>
@ -47,8 +47,8 @@ To learn more about extending a pattern, see [Design inheritance](/howtos/code/i
To create a truly gender-neutral pattern — one that will adapt to breasts only if they are
present — you can use this plugin, but you'll also need a few other things:
- You'll need to mark the breast measurements as [optional measurements](/reference/api/config/optionalmeasurements)
- You'll need to [conditionally load this plugin](/guides/plugins/conditionally-loading-build-time-plugins)
- You'll need to mark the breast measurements as [optional measurements](/reference/api/config/optionalmeasurements)
- You'll need to [conditionally load this plugin](/guides/plugins/conditionally-loading-build-time-plugins)
You can see an example of this in [our Teagan design][3].
@ -77,7 +77,8 @@ import config from "../config";
const Pattern = new freesewing.Design(config, bust);
```
[1]: https://github.com/freesewing/freesewing/blob/develop/packages/carlita/src/index.js#L12
[2]: https://github.com/freesewing/freesewing/blob/develop/packages/carlton
[3]: https://github.com/freesewing/freesewing/blob/develop/packages/teagan/src/index.js

View file

@ -4,12 +4,12 @@ title: "@freesewing/plugin-buttons"
The **@freesewing/plugin-buttons** plugin provides the following [snippets](/reference/api/snippets):
- [button](/reference/api/snippets/button)
- [buttonhole](/reference/api/snippets/buttonhole)
- [buttonhole-start](/reference/api/snippets/buttonhole-start)
- [buttonhole-end](/reference/api/snippets/buttonhole-end)
- [snap-stud](/reference/api/snippets/snap-stud)
- [snap-socket](/reference/api/snippets/snap-socket)
- [button](/reference/api/snippets/button)
- [buttonhole](/reference/api/snippets/buttonhole)
- [buttonhole-start](/reference/api/snippets/buttonhole-start)
- [buttonhole-end](/reference/api/snippets/buttonhole-end)
- [snap-stud](/reference/api/snippets/snap-stud)
- [snap-socket](/reference/api/snippets/snap-socket)
<Example part="plugin_buttons">
An example of the button, buttonhole, buttonhole-start, buttonhole-end, snap-stud, and snap-socket snippets
@ -41,11 +41,10 @@ const Pattern = new freesewing.Design(config, buttons);
```
Now you can use the
[button](/reference/api/snippets/button),
[buttonhole](/reference/api/snippets/buttonhole),
[buttonhole-start](/reference/api/snippets/buttonhole-start),
[buttonhole-end](/reference/api/snippets/buttonhole-end),
[snap-stud](/reference/api/snippets/snap-stud), and
[button](/reference/api/snippets/button),
[buttonhole](/reference/api/snippets/buttonhole),
[buttonhole-start](/reference/api/snippets/buttonhole-start),
[buttonhole-end](/reference/api/snippets/buttonhole-end),
[snap-stud](/reference/api/snippets/snap-stud), and
[snap-socket](/reference/api/snippets/snap-socket)
snippets in your designs.

View file

@ -2,8 +2,8 @@
title: "@freesewing/plugin-cutonfold"
---
The **@freesewing/plugin-cutonfold** plugin provides
[the cutonfold macro](/reference/api/macros/cutonfold) which adds a cut-on-fold
The **@freesewing/plugin-cutonfold** plugin provides
[the cutonfold macro](/reference/api/macros/cutonfold) which adds a cut-on-fold
indicator to your design.
<Example part="plugin_cutonfold">

View file

@ -3,18 +3,18 @@ title: "@freesewing/plugin-dimension"
---
The **@freesewing/plugin-dimension** plugin provides a variety of macros
to facilitate adding *dimensions* to your design. By *dimensions* we mean
the indicators for distance that are added to patterns
to facilitate adding *dimensions* to your design. By *dimensions* we mean
the indicators for distance that are added to patterns
in [paperless mode](/reference/api/settings/paperless).
The following macors are provided by this plugin:
- [hd](/reference/api/macros/hd) : Adds a horizontal dimension
- [vd](/reference/api/macros/vd) : Adds a vertical dimension
- [ld](/reference/api/macros/ld) : Adds a linear dimension
- [pd](/reference/api/macros/pd) : Adds a dimension along a path
- [rmd](/reference/api/macros/rmd) : Removes a dimension
- [rmad](/reference/api/macros/rmad) : Removes all dimensions with a default prefix
- [hd](/reference/api/macros/hd) : Adds a horizontal dimension
- [vd](/reference/api/macros/vd) : Adds a vertical dimension
- [ld](/reference/api/macros/ld) : Adds a linear dimension
- [pd](/reference/api/macros/pd) : Adds a dimension along a path
- [rmd](/reference/api/macros/rmd) : Removes a dimension
- [rmad](/reference/api/macros/rmad) : Removes all dimensions with a default prefix
<Example part="plugin_dimension">
@ -47,12 +47,11 @@ import config from "../config";
const Pattern = new freesewing.Design(config, dimension);
```
Now you can use the
[hd](/reference/api/macros/hd/),
[vd](/reference/api/macros/vd/),
[ld](/reference/api/macros/ld/),
[pd](/reference/api/macros/pd/),
Now you can use the
[hd](/reference/api/macros/hd/),
[vd](/reference/api/macros/vd/),
[ld](/reference/api/macros/ld/),
[pd](/reference/api/macros/pd/),
[rmd](/reference/api/macros/rmd/), and
[rmad](/reference/api/macros/rmad/)
[rmad](/reference/api/macros/rmad/)
macros in your parts.

View file

@ -9,5 +9,3 @@ Refer to [the plugin guide](/guides/plugins) for an in-depth look into plugins.
We maintain the following plugins for @freesewing/core:
<ReadMore />

View file

@ -3,7 +3,7 @@ title: "@freesewing/plugin-export-dxf"
---
The **@freesewing/plugin-export-dxf** plugin exports your pattern
to [the DXF file format](https://en.wikipedia.org/wiki/AutoCAD_DXF).
to [the DXF file format](https://en.wikipedia.org/wiki/AutoCAD_DXF).
It will attach the [the postDraft lifecycle
hook](/reference/api/hooks/postdraft) to add a `renderDxf()` method
to the pattern object.
@ -13,7 +13,7 @@ to the pattern object.
##### This is de-facto unmaintained
This plugin is de-facto unmaintained because I have no use for it.
I keep it around in case it might be useful, and I've used it
I keep it around in case it might be useful, and I've used it
myself for exporting to different software.
The being said, DXF is a poor choice as a file format for storing sewing patterns.
@ -30,7 +30,7 @@ npm install @freesewing/plugin-export-dxf
## Usage
Like all [run-time plugins](/guides/plugins/types-of-plugins#run-time-plugins), you
load them by by passing them to the `use()` method of an instatiated pattern.
load them by by passing them to the `use()` method of an instatiated pattern.
That method is chainable, so if you have multiple plugins you can just chain them together.
@ -41,5 +41,5 @@ import theme from "@freesewing/plugin-theme";
const pattern = new Aaron().use(theme);
```
After calling `pattern.draft()` you will be able to call `pattern.renderDxf()`
After calling `pattern.draft()` you will be able to call `pattern.renderDxf()`
which will return the Dxf output.

View file

@ -2,10 +2,10 @@
title: "@freesewing/plugin-flip"
---
The **@freesewing/plugin-flip** plugin provides [the flip
macro](/reference/apis/macros/flip/) which flips (mirrors)
The **@freesewing/plugin-flip** plugin provides [the flip
macro](/reference/apis/macros/flip/) which flips (mirrors)
an entire part vertically around the Y-axis.
It's typically used to create a right and left pattern part from
It's typically used to create a right and left pattern part from
the same basis.
## Installation

View file

@ -2,14 +2,14 @@
title: "@freesewing/plugin-gore"
---
The **@freesewing/plugin-gore** plugin provides
The **@freesewing/plugin-gore** plugin provides
[the gore macro](/reference/api/macros/gore).
This macro allows you to generate [gore
segments](https://en.wikipedia.org/wiki/Gore_(segment)) —
2D panels to create a sphehrical shape as used in hats for example —
This macro allows you to generate [gore
segments](https://en.wikipedia.org/wiki/Gore_\(segment\)) —
2D panels to create a sphehrical shape as used in hats for example —
to your design.
You'll be happy to hear that this plugin handles all the
You'll be happy to hear that this plugin handles all the
mathematics for you to create a (part-)sphere in your patterns.
## Installation
@ -32,4 +32,3 @@ const Pattern = new freesewing.Design(config, gore);
```
Now you can use the [gore](/reference/api/macros/gore) macro in your parts.

View file

@ -2,7 +2,7 @@
title: "@freesewing/plugin-grainline"
---
The **@freesewing/plugin-grainline** plugin provides [the grainline
The **@freesewing/plugin-grainline** plugin provides [the grainline
macro](/reference/macros/grainline/) which adds a *grainline* indicator
to your design.

View file

@ -3,7 +3,7 @@ title: "@freesewing/plugin-i18n"
---
The **@freesewing/plugin-i18n** plugin provides a mechanism to translate your designs.
It does that by attaching to [the insertText lifecycle hook](/reference/api/hooks/inserttext) to
It does that by attaching to [the insertText lifecycle hook](/reference/api/hooks/inserttext) to
intercept all operations that add text to a design and attempt to translate the text
prior to insertion.
@ -22,7 +22,7 @@ npm install @freesewing/plugin-i18n
## Usage
Like all [build-time plugins](/guides/plugins/#build-time-plugins), you load them
Like all [build-time plugins](/guides/plugins/#build-time-plugins), you load them
by passing them to the [`freesewing.Design`](/reference/api#design) constructor:
```js
@ -50,5 +50,3 @@ It should be structured as such:
}
}
```

View file

@ -35,4 +35,3 @@ const Pattern = new freesewing.Design(config, logo);
```
You can now use the [logo](/reference/api/snippets/logo) snippet in your parts.

View file

@ -9,13 +9,13 @@ they can be deduced from the measurements that are provided.
It will add the following measurements:
- `seatFront` (if both `seat` and `seatBack` are provided)
- `seatBackArc` (if both `seat` and `seatBack` are provided)
- `seatFrontArc` (if both `seat` and `seatBack` are provided)
- `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)
- `seatFront` (if both `seat` and `seatBack` are provided)
- `seatBackArc` (if both `seat` and `seatBack` are provided)
- `seatFrontArc` (if both `seat` and `seatBack` are provided)
- `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)
## Installation
@ -35,4 +35,3 @@ import config from "../config";
const Pattern = new freesewing.Design(config, measurements);
```

View file

@ -2,7 +2,7 @@
title: "@freesewing/plugin-mirror"
---
The **@freesewing/plugin-mirror** plugin provides [the mirror
The **@freesewing/plugin-mirror** plugin provides [the mirror
macro](/reference/api/macros/mirror) which facilitates mirroring
a number of points and/or paths around a given mirror line.
@ -28,5 +28,3 @@ const Pattern = new freesewing.Design(config, mirror);
```
You can now use the [mirror](/reference/api/macros/mirror) macro in your parts.

View file

@ -4,8 +4,8 @@ title: "@freesewing/plugin-notches"
The **@freesewing/plugin-notces** plugin provides the following [snippets](/reference/api/snippets):
- [notch](/reference/api/snippets/notch)
- [bnotch](/reference/api/snippets/bnotch)
- [notch](/reference/api/snippets/notch)
- [bnotch](/reference/api/snippets/bnotch)
<Example part="plugin_notches">
An example of the button, buttonhole, buttonhole-start, buttonhole-end, snap-stud, and snap-socket snippets
@ -37,7 +37,6 @@ const Pattern = new freesewing.Design(config, notches);
```
Now you can use the
[notch](/reference/api/snippets/notch) and
[notch](/reference/api/snippets/notch) and\
[bnotch](/reference/api/snippets/buttonhole)
snippets in your designs.

View file

@ -2,13 +2,13 @@
title: "@freesewing/plugin-round"
---
The **@freesewing/plugin-round** plugin provides [the
round macro](/reference/api/macros/round) which helps you round
corners on your designs.
The **@freesewing/plugin-round** plugin provides [the
round macro](/reference/api/macros/round) which helps you round
corners on your designs.
<Warning>
##### Straight corners only
##### Straight corners only
The round macro is intended for rounding 90° angles.
It does not support rounding other angles/corners.
@ -43,5 +43,3 @@ const Pattern = new freesewing.Design(config, round);
```
Now you can use [the round macro](/reference/macros/round/): in your parts.

View file

@ -2,7 +2,7 @@
title: "@freesewing/plugin-scalebox"
---
The **@freesewing/plugin-scalebox** plugin provides [the
The **@freesewing/plugin-scalebox** plugin provides [the
scalebox macro](/reference/api/macros/scalebox/) with facilitates
adding a scalebox to your design, so users can verify that the pattern
is printed at the correct scale.

View file

@ -2,7 +2,7 @@
title: "@freesewing/plugin-sprinkle"
---
The **@freesewing/plugin-sprinkle** plugin provides [the
The **@freesewing/plugin-sprinkle** plugin provides [the
sprinkle macro](/reference/api/macros/sprinkle/) which is a faster way
to add several of the same snippets to your designs (think of it as
*sprinkling* them onto your parts).

View file

@ -2,7 +2,7 @@
title: "@freesewing/plugin-svgattr"
---
The **@freesewing/plugin-svgattr** plugin takes an object of key-value
The **@freesewing/plugin-svgattr** plugin takes an object of key-value
pairs and adds them ass attributes to your SVG document on render.
It leverages [the preRender lifecycle hook](/reference/api/hooks/prerender) to do so.
@ -27,5 +27,3 @@ const myAaron = new Aaron()
```
You should pass a second argument which holds key-value pairs of the attributes you want to add to the SVG tag.

View file

@ -6,7 +6,6 @@ The **@freesewing-plugin-theme** plugin provides CSS styling for SVG output.
It leverages [the preRender lifecycle hook](/reference/api/hooks/prerender) to
accomplish this.
<Note>
##### Only applies to SVG/PS/PDF output
@ -27,7 +26,7 @@ npm install @freesewing/plugin-theme
## Usage
Like all [run-time plugins](/guides/plugins/types-of-plugins#run-time-plugins), you
load them by by passing them to the `use()` method of an instatiated pattern.
load them by by passing them to the `use()` method of an instatiated pattern.
That method is chainable, so if you have multiple plugins you can just chain them together.
@ -37,4 +36,3 @@ import theme from "@freesewing/plugin-theme";
const pattern = new Aaron().use(theme);
```

View file

@ -2,7 +2,7 @@
title: "@freesewing/plugin-title"
---
The **@freesewing/plugin-title** plugin provides [the
The **@freesewing/plugin-title** plugin provides [the
title macro](/reference/api/macros/title/) which facilitates adding part titles
to your desings.
@ -34,4 +34,3 @@ const Pattern = new freesewing.Design(config, title);
```
Now you can use the [title](/reference/api/macros/title/) macro in your parts.

View file

@ -16,7 +16,7 @@ npm install @freesewing/plugin-bartack
## Usage
Like all [run-time plugins](/guides/plugins/types-of-plugins#run-time-plugins), you
load them by by passing them to the `use()` method of an instatiated pattern.
load them by by passing them to the `use()` method of an instatiated pattern.
That method is chainable, so if you have multiple plugins you can just chain them together.
@ -26,4 +26,3 @@ import versionfreeSvg from "@freesewing/plugin-versionfree-svg";
const pattern = new Aaron().use(versionfreeSvg);
```