chore(markdown): Updated docs after plugin changes
This commit is contained in:
parent
53eb0c6546
commit
d01ce1e538
25 changed files with 39 additions and 34 deletions
|
@ -3,7 +3,7 @@ title: banner
|
||||||
---
|
---
|
||||||
|
|
||||||
The `banner` macro allows you to add repeating text along a path.
|
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
|
## Signature
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,8 @@ title: bartack
|
||||||
---
|
---
|
||||||
|
|
||||||
The `bartack` macro allows you to add a _bartack_ marker to your sewing
|
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
|
## Signature
|
||||||
|
|
||||||
|
|
|
@ -4,7 +4,7 @@ title: bartackAlong
|
||||||
|
|
||||||
The `bartackAlong` macro allows you to add a _bartack_ marker to your sewing pattern.
|
The `bartackAlong` macro allows you to add a _bartack_ marker to your sewing pattern.
|
||||||
More specifically, a bartack along a path.
|
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
|
## Signature
|
||||||
|
|
||||||
|
|
|
@ -3,8 +3,8 @@ title: bartackFractionAlong
|
||||||
---
|
---
|
||||||
|
|
||||||
The `bartackFractionAlong` macro allows you to add a _bartack_ marker to your
|
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
|
sewing pattern. More specifically, a bartack along a fraction of a path.
|
||||||
is provided by the [bartack plugin](/reference/plugins/bartack/).
|
It is provided by the [annotations plugin](/reference/plugins/annotations).
|
||||||
|
|
||||||
## Signature
|
## Signature
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,7 @@ title: cutonfold
|
||||||
---
|
---
|
||||||
|
|
||||||
The `cutonfold` macro adds a _cut on fold_ indicator to your pattern.
|
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
|
## Signature
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,7 @@ title: grainline
|
||||||
---
|
---
|
||||||
|
|
||||||
The `grainline` macro adds a _grainline_ indicator to your pattern.
|
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
|
## Signature
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,7 @@ title: hd
|
||||||
---
|
---
|
||||||
|
|
||||||
The `hd` macro adds a _horizontal dimension_ to your pattern.
|
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
|
## Signature
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,7 @@ title: ld
|
||||||
---
|
---
|
||||||
|
|
||||||
The `ld` macro adds a _linear dimension_ to your pattern.
|
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
|
## Signature
|
||||||
|
|
||||||
|
|
|
@ -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
|
The white inside of the box provides a metric scale, and the black outside
|
||||||
of the box provides an imperial scale.
|
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/).
|
It is the mini version of [the scalebox macro](/reference/macros/scalebox/).
|
||||||
|
|
||||||
## Signature
|
## Signature
|
||||||
|
|
|
@ -31,15 +31,18 @@ macro('mirror', {
|
||||||
paths.example = new Path()
|
paths.example = new Path()
|
||||||
.move(points.from)
|
.move(points.from)
|
||||||
.curve(points.cp1, points.cp2, points.to)
|
.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', {
|
macro('mirror', {
|
||||||
clone: true,
|
clone: true,
|
||||||
mirror: [
|
mirror: [ points.m1, points.m2 ],
|
||||||
new Point(20,10),
|
paths: Object.keys(paths),
|
||||||
new Point(20,20),
|
|
||||||
],
|
|
||||||
paths: Object.values(paths),
|
|
||||||
points: Object.values(points),
|
|
||||||
})
|
})
|
||||||
|
|
||||||
return part
|
return part
|
||||||
|
|
|
@ -3,8 +3,8 @@ title: pd
|
||||||
---
|
---
|
||||||
|
|
||||||
The `pd` macro adds a _path dimension_ to your pattern, indicating the length
|
The `pd` macro adds a _path dimension_ to your pattern, indicating the length
|
||||||
of a path. It is provided by the [dimension
|
of a path.
|
||||||
plugin](/reference/plugins/dimension/).
|
It is provided by the [annotations plugin](/reference/plugins/annotations).
|
||||||
|
|
||||||
## Signature
|
## Signature
|
||||||
|
|
||||||
|
|
|
@ -3,8 +3,8 @@ title: rmad
|
||||||
---
|
---
|
||||||
|
|
||||||
The `rmad` macro removes all dimensions with the exception of those that were
|
The `rmad` macro removes all dimensions with the exception of those that were
|
||||||
created with a custom ID. It is provided by the [dimension
|
created with a custom ID.
|
||||||
plugin](/reference/plugins/dimension/).
|
It is provided by the [annotations plugin](/reference/plugins/annotations).
|
||||||
|
|
||||||
## Signature
|
## Signature
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,7 @@ title: rmd
|
||||||
---
|
---
|
||||||
|
|
||||||
The `rmd` macro removes a dimension.
|
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:
|
To be able to use this plugin, you need to give your dimension an id:
|
||||||
|
|
||||||
|
|
|
@ -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
|
The white inside of the box provides a metric scale, and the black outside
|
||||||
of the box provides an imperial scale.
|
of the box provides an imperial scale.
|
||||||
|
|
||||||
The `scalebox` macro is provided by the [scalebox
|
The `scalebox` macro is is provided by the [annotations
|
||||||
plugin](/reference/plugins/scalebox).
|
plugin](/reference/plugins/annotations).
|
||||||
|
|
||||||
## Signature
|
## Signature
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,7 @@ title: title
|
||||||
---
|
---
|
||||||
|
|
||||||
The `title` macro adds a title to a pattern part.
|
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
|
## Signature
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,7 @@ title: vd
|
||||||
---
|
---
|
||||||
|
|
||||||
The `vd` macro adds a _vertical dimension_ to your pattern.
|
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
|
## Signature
|
||||||
|
|
||||||
|
|
|
@ -5,7 +5,7 @@ title: bnotch
|
||||||
The `bnotch` snippet is intended for notches at the back, or when you
|
The `bnotch` snippet is intended for notches at the back, or when you
|
||||||
need an alternative to the default `notch`.
|
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
|
## Example
|
||||||
|
|
||||||
|
|
|
@ -4,7 +4,7 @@ title: button
|
||||||
|
|
||||||
The `button` snippet is used to mark button placement.
|
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
|
## Example
|
||||||
|
|
||||||
|
|
|
@ -6,7 +6,7 @@ The `buttonhole-end` snippet is used to mark buttonhole placement.
|
||||||
This particular snippet places the buttonhole's end on its
|
This particular snippet places the buttonhole's end on its
|
||||||
anchor point.
|
anchor point.
|
||||||
|
|
||||||
It is provided by [plugin-buttons](/reference/plugins/buttons/).
|
It is provided by [plugin-annotations](/reference/plugins/annotations/).
|
||||||
|
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
|
@ -6,7 +6,7 @@ The `buttonhole-start` snippet is used to mark buttonhole placement.
|
||||||
This particular snippet places the buttonhole's start on its
|
This particular snippet places the buttonhole's start on its
|
||||||
anchor point.
|
anchor point.
|
||||||
|
|
||||||
It is provided by [plugin-buttons](/reference/plugins/buttons/).
|
It is provided by [plugin-annotations](/reference/plugins/annotations/).
|
||||||
|
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
|
@ -6,7 +6,7 @@ The `buttonhole` snippet is used to mark buttonhole placement.
|
||||||
This particular snippet places the buttonhole centrally on its
|
This particular snippet places the buttonhole centrally on its
|
||||||
anchor point.
|
anchor point.
|
||||||
|
|
||||||
It is provided by [plugin-buttons](/reference/plugins/buttons/).
|
It is provided by [plugin-annotations](/reference/plugins/annotations/).
|
||||||
|
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
|
@ -4,7 +4,7 @@ title: logo
|
||||||
|
|
||||||
The `logo` snippet inserts the FreeSewing 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
|
## Example
|
||||||
|
|
||||||
|
|
|
@ -4,7 +4,7 @@ title: notch
|
||||||
|
|
||||||
The `notch` snippet is intended for notches.
|
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
|
## Example
|
||||||
|
|
||||||
|
|
|
@ -4,7 +4,7 @@ title: snap-socket
|
||||||
|
|
||||||
The `snap-socket` snippet is used to mark the socket part of a snap button.
|
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
|
## Example
|
||||||
|
|
||||||
|
|
|
@ -4,7 +4,7 @@ title: snap-stud
|
||||||
|
|
||||||
The `snap-stud` snippet is used to mark the stud part of a snap button.
|
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
|
||||||
|
|
||||||
<Example caption="An example of the snap-stud snippet">
|
<Example caption="An example of the snap-stud snippet">
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue