VSinerva/freesewing
1
0
Fork 0
Code Activity

Revert "chore: Linting for markdown and js"

Browse source 
This reverts commit 1c92e0f655.
This commit is contained in:
joostdecock 2021-10-17 18:26:00 +02:00
parent 994874fa72
commit cba1ab19c8
6627 changed files with 25791 additions and 24211 deletions
Download patch file Download diff file Expand all files Collapse all files

8
markdown/dev/reference/macros/bartack/en.md
View file

@ -1,6 +1,6 @@
***
## title: bartack
---
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/).
@ -17,7 +17,7 @@ macro('bartack', {
})
```
| Property | Default | Type | Description |
| Property | Default | Type | Description |
|-------------:|------------|------------|-------------|
| `angle` | `0` | `number` | The angle under which to draw the bartack |
| `density` | `3` | `number` | Controls how close the stitches are togeter |

9
markdown/dev/reference/macros/bartackalong/en.md
View file

@ -1,6 +1,6 @@
***
## title: bartackAlong
---
title: bartackAlong
---
The `bartackAlong` macro allows you to add a *bartack* marker to your sewing pattern.
More specifically, a bartack along a path.
@ -31,7 +31,7 @@ macro('sprinkle', {
})
```
| Property | Default | Type | Description |
| Property | Default | Type | Description |
|-------------:|------------|------------|-------------|
| `angle` | `0` | `number` | The angle under which to draw the bartack |
| `density` | `3` | `number` | Controls how close the stitches are togeter |
@ -41,3 +41,4 @@ macro('sprinkle', {
| `prefix` | | `string` | A prefix to apply to the names of the generated path and points |
| `suffix` | | `string` | A suffix to apply to the names of the generated path and points |
| `width` | `3` | `number` | Width of the bartack |

9
markdown/dev/reference/macros/bartackfractionalong/en.md
View file

@ -1,6 +1,6 @@
***
## title: bartackFractionAlong
---
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.
@ -33,7 +33,7 @@ macro('sprinkle', {
})
```
| Property | Default | Type | Description |
| Property | Default | Type | Description |
|-------------:|------------|------------|-------------|
| `angle` | `0` | `number` | The angle under which to draw the bartack |
| `density` | `3` | `number` | Controls how close the stitches are togeter |
@ -45,3 +45,4 @@ macro('sprinkle', {
| `start` | `0` | `number` | At which fraction of the path length (from `0` to `1`) should the bartack start |
| `suffix` | | `string` | A suffix to apply to the names of the generated path and points |
| `width` | `3` | `number` | Width of the bartack |

13
markdown/dev/reference/macros/cutonfold/en.md
View file

@ -1,8 +1,8 @@
***
---
title: cutonfold
---
## 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).
<Example part="plugin_cutonfold" caption="Example of the cut on fold indicator added by this macro" />
@ -15,10 +15,13 @@ macro('cutonfold', {
}
```
| Property | Default | Type | Description |
| Property | Default | Type | Description |
|------------:|---------|---------------------|-------------|
| `from` | | [Point](/reference/api/point) | The startpoint of the *cut on fold* indicator |
| `to` | | [Point](/reference/api/point) | The endpoint of the *cut on fold* indicator |
| `margin` | 5 | [Point](/reference/api/point) | The distance in % to keep from the start/end edge |
| `offset` | 50 | Number | The distance in mm to offset from the line from start to end |
| `grainline` | `false` | Boolean | Whether this cutonfold indicator is also the grainline |

7
markdown/dev/reference/macros/en.md
View file

@ -1,9 +1,8 @@
***
---
title: Macros
for: developers
about: Complete list of all available macros and how to use them
----------------------------------------------------------------
---
Macros are a way to combine different operations into a single command,
and are typically provided by plugins.
@ -19,3 +18,5 @@ Below is a list of available macros:
For more info on a specific macro and examples, follow the link to the plugin that provides the macro.
</Tip>

16
markdown/dev/reference/macros/flip/en.md
View file

@ -1,8 +1,8 @@
***
---
title: flip
---
## title: flip
The `flip` macro flips (mirrors) an entire part vertically around the Y-axis.\
The `flip` macro flips (mirrors) an entire part vertically around the Y-axis.
It takes no arguments, and is provided by the [flip plugin](/reference/plugins/flip).
```js
@ -11,6 +11,8 @@ macro("flip")
Under the hood, this macro will:
* Go through all Points in your Part, and multiply their X-coordinate by -1
* Go through all the Paths in your Part, and for each drawing operation will multiply the X-coordinare by -1
* Go through all the Snippets in your Part and multiply the X-coordinate of the anchor point by -1
- Go through all Points in your Part, and multiply their X-coordinate by -1
- Go through all the Paths in your Part, and for each drawing operation will multiply the X-coordinare by -1
- Go through all the Snippets in your Part and multiply the X-coordinate of the anchor point by -1

11
markdown/dev/reference/macros/grainline/en.md
View file

@ -1,8 +1,8 @@
***
---
title: grainline
---
## 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/).
<Example part="plugin_grainline" caption="Example of the grainline indicator added by this macro" />
@ -14,7 +14,8 @@ macro("grainline", {
}
```
| Property | Default | Type | Description |
| Property | Default | Type | Description |
|------------:|---------|---------------------|-------------|
| `from` | | [Point](/reference/api/point) | The startpoint of the *grainline* indicator |
| `to` | | [Point](/reference/api/point) | The endpoint of the *grainline* indicator |

19
markdown/dev/reference/macros/hd/en.md
View file

@ -1,13 +1,13 @@
***
---
title: hd
---
## 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/).
<Example
part="point_dx"
caption="An example of a horizontal dimension"
part="point_dx"
caption="An example of a horizontal dimension"
/>
```js
@ -18,7 +18,7 @@ macro('hd', {
})
```
| Property | Default | Type | Description |
| Property | Default | Type | Description |
|----------------:|----------|---------------------|-------------|
| `from` | | [Point](/reference/api/point) | The startpoint of the dimension |
| `to` | | [Point](/reference/api/point) | The endpoint of the dimension |
@ -32,7 +32,8 @@ macro('hd', {
Setting a custom ID will:
* Allow removal of the dimension with [the `rmd` macro](/reference/macros/rmd)
* Prevent removal of the dimension with [the `rmad` macro](/reference/macros/rmad/)
- Allow removal of the dimension with [the `rmd` macro](/reference/macros/rmd)
- Prevent removal of the dimension with [the `rmad` macro](/reference/macros/rmad/)
</Note>

20
markdown/dev/reference/macros/ld/en.md
View file

@ -1,13 +1,13 @@
***
---
title: ld
---
## 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/).
<Example
part="point_dist"
caption="An example of a linear dimension"
part="point_dist"
caption="An example of a linear dimension"
/>
```js
@ -18,7 +18,8 @@ macro('ld', {
})
```
| Property | Default | Type | Description |
| Property | Default | Type | Description |
|-----------------|---------|---------------------|-------------|
| `from` | | [Point](/reference/api/point) | The startpoint of the dimension |
| `to` | | [Point](/reference/api/point) | The endpoint of the dimension |
@ -32,7 +33,8 @@ macro('ld', {
Setting a custom ID will:
* Allow removal of the dimension with [the `rmd` macro](/reference/macros/rmd)
* Prevent removal of the dimension with [the `rmad` macro](/reference/macros/rmad/)
- Allow removal of the dimension with [the `rmd` macro](/reference/macros/rmd)
- Prevent removal of the dimension with [the `rmad` macro](/reference/macros/rmad/)
</Note>

10
markdown/dev/reference/macros/miniscale/en.md
View file

@ -1,6 +1,6 @@
***
## title: miniscale
---
title: miniscale
---
The `miniscale` macro adds a mini *scale box* to your pattern. This box allows
users to verify their pattern is printed to scale.
@ -16,7 +16,9 @@ macro('miniscale', {
})
```
| Property | Default | Type | Description |
| Property | Default | Type | Description |
|-------------|---------|---------------------|-------------|
| `at` | | [Point](/reference/api/point) | The point to anchor the *scale box* on |
| `rotate` | 0 | Number | Rotation in degrees |

9
markdown/dev/reference/macros/mirror/en.md
View file

@ -1,6 +1,6 @@
***
## title: mirror
---
title: mirror
---
The `mirror` macro allows you to mirror points and/or paths around a mirror line.
It is provided by the [mirror plugin](/reference/plugins/mirror/).
@ -31,7 +31,7 @@ macro('sprinkle', {
})
```
| Property | Default | Type | Description |
| Property | Default | Type | Description |
|-------------:|------------|------------|-------------|
| `mirror` | | `array` | Array with 2 [Point](/reference/api/point) objects that define the *mirror line* |
| `clone` | `true` | `bool` | Whether to clone mirrored points and or paths |
@ -39,3 +39,4 @@ macro('sprinkle', {
| `paths` | | `array` | An array of [Path](/reference/api/path) objects |
| `prefix` | `mirrored` | `string` | A prefix to apply to the names of the clones points and or paths. Ignored if `nameFormat` is set |
| `nameFormat` | | `function` | A method that receives the name of the path or point and should return the name for the cloned path and or point |

16
markdown/dev/reference/macros/pd/en.md
View file

@ -1,8 +1,8 @@
***
---
title: pd
---
## title: pd
The `pd` macro adds a *path dimension* to your pattern, indicating the length of a path.\
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/).
<Example part="path_length" caption="Example of a multiple path dimensions" />
@ -14,7 +14,7 @@ macro('pd', {
})
```
| Property | Default | Type | Description |
| Property | Default | Type | Description |
|----------------:|---------|---------------------|-------------|
| `path` | | [Path](/reference/api/path) | The path to draw the dimension along |
| `offset` | 0 | Number | The offset at which to draw the dimension |
@ -27,7 +27,9 @@ macro('pd', {
Setting a custom ID will:
* Allow removal of the dimension with [the `rmd` macro](/reference/macros/rmd)
* Prevent removal of the dimension with [the `rmad` macro](/reference/macros/rmad/)
- Allow removal of the dimension with [the `rmd` macro](/reference/macros/rmd)
- Prevent removal of the dimension with [the `rmad` macro](/reference/macros/rmad/)
</Note>

6
markdown/dev/reference/macros/rmad/en.md
View file

@ -1,6 +1,6 @@
***
## title: rmad
---
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/).

9
markdown/dev/reference/macros/rmd/en.md
View file

@ -1,6 +1,6 @@
***
## title: rmd
---
title: rmd
---
The `rmd` macro removes a dimension.
It is provided by the [dimension plugin](/reference/plugins/dimension/).
@ -24,6 +24,7 @@ macro('rmd', {
})
```
| Property | Default | Type | Description |
| Property | Default | Type | Description |
|----------|---------|----------|-------------|
| `id` | | `string` | The id of the dimension to remove |

9
markdown/dev/reference/macros/round/en.md
View file

@ -1,6 +1,6 @@
***
## title: round
---
title: round
---
The `round` macro rounds a corner. It is provided by the [round plugin](/reference/plugins/round/).
@ -19,7 +19,7 @@ macro('round', {
})
```
| Property | Default | Type | Description |
| Property | Default | Type | Description |
|------------:|---------|---------------------|-------------|
| `from` | | [Point](/reference/api/point) | The startpoint towards the corner to round |
| `to` | | [Point](/reference/api/point) | The endpoint away from the corner to round |
@ -28,3 +28,4 @@ macro('round', {
| `prefix` | | String | A prefix to give to the points and paths created by this macro |
| `render` | `false` | Boolean | Whether to render the path created by this macro |
| `class` | | String | Class(es) to assign to the path created by this macro |

9
markdown/dev/reference/macros/scalebox/en.md
View file

@ -1,6 +1,6 @@
***
## title: scalebox
---
title: scalebox
---
The `scalebox` macro adds a *scale box* to your pattern. This box allows
users to verify their pattern is printed to scale.
@ -15,7 +15,7 @@ macro('scalebox', {
})
```
| Property | Default | Type | Description |
| Property | Default | Type | Description |
|-------------|---------|---------------------|-------------|
| `at` | | [Point](/reference/api/point) | The point to anchor the *scale box* on |
| `lead` | FreeSewing | String | The lead text above the title |
@ -24,3 +24,4 @@ macro('scalebox', {
| `rotate` | 0 | Number | Rotation in degrees |
(\*) `freesewingIsMadeByJoostDeCockAndContributors \n withTheFinancialSupportOfOurPatrons`

12
markdown/dev/reference/macros/sprinkle/en.md
View file

@ -1,8 +1,8 @@
***
---
title: sprinkle
---
## title: sprinkle
The `sprinkle` macro facilitates adding snippets to your pattern in bulk.\
The `sprinkle` macro facilitates adding snippets to your pattern in bulk.
It is by the [sprinkle plugin](/reference/plugins/sprinkle).
<Example part="plugin_sprinkle" caption="Example of button snippets sprinkled on a pattern by this macro" />
@ -14,7 +14,9 @@ macro('sprinkle', {
})
```
| Property | Default | Type | Description |
| Property | Default | Type | Description |
|------------:|---------|------------------|-------------|
| `snippet` | | String | Name of the snippet to sprinkle |
| `on` | `[]` | Array of strings | An array with **the names** of points to add the snippet on |

11
markdown/dev/reference/macros/title/en.md
View file

@ -1,13 +1,13 @@
***
---
title: title
---
## 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).
<Example part="plugin_title" caption="Example of a title added by this macro" />
| Property | Default | Type | Description |
| Property | Default | Type | Description |
| ----------:| :-----: | ---------------------------------------------------------- |
| `at` | | [Point](/reference/api/point) | The point at which to insert the title |
| `nr` | | String | The number of the pattern part |
@ -16,3 +16,4 @@ It is provided by the [title plugin](/reference/plugins/title).
| `append` | `false` | Boolean | Set this to `true` to append the `nr` to any text already set in Point `at`'s attributes, rather than overwrite it |
| `rotation` | 0 | Number | An optional rotation in degrees |
| `scale` | 1 | Number | An optional scaling factor |

21
markdown/dev/reference/macros/vd/en.md
View file

@ -1,13 +1,13 @@
***
---
title: vd
---
## 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/).
<Example
part="point_dy"
caption="An example of a vertical dimension"
part="point_dy"
caption="An example of a vertical dimension"
/>
```js
@ -18,7 +18,7 @@ macro('vd', {
})
```
| Property | Default | Type | Description |
| Property | Default | Type | Description |
|----------------:|---------|---------------------|-------------|
| `from` | | [Point](/reference/api/point) | The startpoint of the dimension |
| `to` | | [Point](/reference/api/point) | The endpoint of the dimension |
@ -32,7 +32,10 @@ macro('vd', {
Setting a custom ID will:
* Allow removal of the dimension with [the `rmd` macro](/reference/macros/rmd)
* Prevent removal of the dimension with [the `rmad` macro](/reference/macros/rmad/)
- Allow removal of the dimension with [the `rmd` macro](/reference/macros/rmd)
- Prevent removal of the dimension with [the `rmad` macro](/reference/macros/rmad/)
</Note>