1
0
Fork 0

chore(markdown): Updated docs after plugin changes

This commit is contained in:
joostdecock 2023-04-15 16:31:45 +02:00
parent 53eb0c6546
commit d01ce1e538
25 changed files with 39 additions and 34 deletions

View file

@ -3,7 +3,7 @@ title: banner
---
The `banner` macro allows you to add repeating text along a path.
It is provided by the [banner plugin](/reference/plugins/banner).
It is provided by the [annotations plugin](/reference/plugins/annotations).
## Signature

View file

@ -3,7 +3,8 @@ title: bartack
---
The `bartack` macro allows you to add a _bartack_ marker to your sewing
pattern. It is provided by the [bartack plugin](/reference/plugins/bartack/).
pattern.
It is provided by the [annotations plugin](/reference/plugins/annotations).
## Signature

View file

@ -4,7 +4,7 @@ title: bartackAlong
The `bartackAlong` macro allows you to add a _bartack_ marker to your sewing pattern.
More specifically, a bartack along a path.
It is provided by the [bartack plugin](/reference/plugins/bartack/).
It is provided by the [annotations plugin](/reference/plugins/annotations).
## Signature

View file

@ -3,8 +3,8 @@ title: bartackFractionAlong
---
The `bartackFractionAlong` macro allows you to add a _bartack_ marker to your
sewing pattern. More specifically, a bartack along a fraction of a path. It
is provided by the [bartack plugin](/reference/plugins/bartack/).
sewing pattern. More specifically, a bartack along a fraction of a path.
It is provided by the [annotations plugin](/reference/plugins/annotations).
## Signature

View file

@ -3,7 +3,7 @@ title: cutonfold
---
The `cutonfold` macro adds a _cut on fold_ indicator to your pattern.
It is provided by the [cutonfold plugin](/reference/plugins/cutonfold).
It is provided by the [annotations plugin](/reference/plugins/annotations).
## Signature

View file

@ -3,7 +3,7 @@ title: grainline
---
The `grainline` macro adds a _grainline_ indicator to your pattern.
It is provided by the [grainline plugin](/reference/plugins/grainline/).
It is provided by the [annotations plugin](/reference/plugins/annotations).
## Signature

View file

@ -3,7 +3,7 @@ title: hd
---
The `hd` macro adds a _horizontal dimension_ to your pattern.
It is provided by the [dimension plugin](/reference/plugins/dimension/).
It is provided by the [annotations plugin](/reference/plugins/annotations).
## Signature

View file

@ -3,7 +3,7 @@ title: ld
---
The `ld` macro adds a _linear dimension_ to your pattern.
It is provided by the [dimension plugin](/reference/plugins/dimension/).
It is provided by the [annotations plugin](/reference/plugins/annotations).
## Signature

View file

@ -7,7 +7,8 @@ users to verify their pattern is printed to scale.
The white inside of the box provides a metric scale, and the black outside
of the box provides an imperial scale.
The `miniscale` macro is provided by the [scalebox plugin](/reference/plugins/scalebox).
The `miniscale` macro is provided by the [annotations
plugin](/reference/plugins/annotations).
It is the mini version of [the scalebox macro](/reference/macros/scalebox/).
## Signature

View file

@ -32,14 +32,17 @@ macro('mirror', {
.move(points.from)
.curve(points.cp1, points.cp2, points.to)
points.m1 = new Point(20,0)
points.m2 = new Point(20,20)
paths.mirror = new Path()
.move(points.m1)
.line(points.m2)
.addClass('stroke-xm dashed stroke-lining')
macro('mirror', {
clone: true,
mirror: [
new Point(20,10),
new Point(20,20),
],
paths: Object.values(paths),
points: Object.values(points),
mirror: [ points.m1, points.m2 ],
paths: Object.keys(paths),
})
return part

View file

@ -3,8 +3,8 @@ title: pd
---
The `pd` macro adds a _path dimension_ to your pattern, indicating the length
of a path. It is provided by the [dimension
plugin](/reference/plugins/dimension/).
of a path.
It is provided by the [annotations plugin](/reference/plugins/annotations).
## Signature

View file

@ -3,8 +3,8 @@ title: rmad
---
The `rmad` macro removes all dimensions with the exception of those that were
created with a custom ID. It is provided by the [dimension
plugin](/reference/plugins/dimension/).
created with a custom ID.
It is provided by the [annotations plugin](/reference/plugins/annotations).
## Signature

View file

@ -3,7 +3,7 @@ title: rmd
---
The `rmd` macro removes a dimension.
It is provided by the [dimension plugin](/reference/plugins/dimension/).
It is provided by the [annotations plugin](/reference/plugins/annotations).
To be able to use this plugin, you need to give your dimension an id:

View file

@ -7,8 +7,8 @@ to verify their pattern is printed to scale.
The white inside of the box provides a metric scale, and the black outside
of the box provides an imperial scale.
The `scalebox` macro is provided by the [scalebox
plugin](/reference/plugins/scalebox).
The `scalebox` macro is is provided by the [annotations
plugin](/reference/plugins/annotations).
## Signature

View file

@ -3,7 +3,7 @@ title: title
---
The `title` macro adds a title to a pattern part.
It is provided by the [title plugin](/reference/plugins/title).
It is provided by the [annotations plugin](/reference/plugins/annotations).
## Signature

View file

@ -3,7 +3,7 @@ title: vd
---
The `vd` macro adds a _vertical dimension_ to your pattern.
It is provided by the [dimension plugin](/reference/plugins/dimension/).
It is provided by the [annotations plugin](/reference/plugins/annotations).
## Signature

View file

@ -5,7 +5,7 @@ title: bnotch
The `bnotch` snippet is intended for notches at the back, or when you
need an alternative to the default `notch`.
It is provided by [plugin-notches](/reference/plugins/notches/).
It is provided by [plugin-annotations](/reference/plugins/annotations/).
## Example

View file

@ -4,7 +4,7 @@ title: button
The `button` snippet is used to mark button placement.
It is provided by [plugin-buttons](/reference/plugins/buttons/).
It is provided by [plugin-annotations](/reference/plugins/annotations/).
## Example

View file

@ -6,7 +6,7 @@ The `buttonhole-end` snippet is used to mark buttonhole placement.
This particular snippet places the buttonhole's end on its
anchor point.
It is provided by [plugin-buttons](/reference/plugins/buttons/).
It is provided by [plugin-annotations](/reference/plugins/annotations/).
## Example

View file

@ -6,7 +6,7 @@ The `buttonhole-start` snippet is used to mark buttonhole placement.
This particular snippet places the buttonhole's start on its
anchor point.
It is provided by [plugin-buttons](/reference/plugins/buttons/).
It is provided by [plugin-annotations](/reference/plugins/annotations/).
## Example

View file

@ -6,7 +6,7 @@ The `buttonhole` snippet is used to mark buttonhole placement.
This particular snippet places the buttonhole centrally on its
anchor point.
It is provided by [plugin-buttons](/reference/plugins/buttons/).
It is provided by [plugin-annotations](/reference/plugins/annotations/).
## Example

View file

@ -4,7 +4,7 @@ title: logo
The `logo` snippet inserts the FreeSewing logo.
It is provided by [plugin-logo](/reference/plugins/logo/).
It is provided by [plugin-annotations](/reference/plugins/annotations/).
## Example

View file

@ -4,7 +4,7 @@ title: notch
The `notch` snippet is intended for notches.
It is provided by [plugin-notches](/reference/plugins/notches/).
It is provided by [plugin-annotations](/reference/plugins/annotations/).
## Example

View file

@ -4,7 +4,7 @@ title: snap-socket
The `snap-socket` snippet is used to mark the socket part of a snap button.
It is provided by [plugin-buttons](/reference/plugins/buttons/).
It is provided by [plugin-annotations](/reference/plugins/annotations/).
## Example

View file

@ -4,7 +4,7 @@ title: snap-stud
The `snap-stud` snippet is used to mark the stud part of a snap button.
It is provided by [plugin-buttons](/reference/plugins/buttons/).
It is provided by [plugin-annotations](/reference/plugins/annotations/).
## Example
<Example caption="An example of the snap-stud snippet">