VSinerva/freesewing
1
0
Fork 0
Code Activity

chore(markdown): Linting of dev docs

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

2
markdown/dev/reference/api/macros/banner/en.md
View file

@ -21,7 +21,7 @@ macro('banner', {
})
```
| Property | Default | Type | Description |
| Property | Default | Type | Description |
|-------------:|------------|------------|-------------|
| `text` | | `text` | The text to place repeat along the path |
| `dy` | `1` | `number` | Controls how far the text will be located above the path |

2
markdown/dev/reference/api/macros/bartack/en.md
View file

@ -19,7 +19,7 @@ macro('bartack', {
})
```
| Property | Default | Type | Description |
| Property | Default | Type | Description |
|-------------:|------------|------------|-------------|
| `anchor` | | `Point` | The point to start the bartack from |
| `angle` | `0` | `number` | The angle under which to draw the bartack |

3
markdown/dev/reference/api/macros/bartackalong/en.md
View file

@ -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 |
@ -43,4 +43,3 @@ 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 |

3
markdown/dev/reference/api/macros/bartackfractionalong/en.md
View file

@ -35,7 +35,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 |
@ -47,4 +47,3 @@ 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 |

8
markdown/dev/reference/api/macros/cutonfold/en.md
View file

@ -2,7 +2,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).
<Example part="plugin_cutonfold">
@ -17,7 +17,7 @@ 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 |
@ -29,9 +29,7 @@ macro('cutonfold', {
###### It's safe to use a corner of your pattern part for this
Since this is typically used on corners, the generated cut-on-fold indicator
Since this is typically used on corners, the generated cut-on-fold indicator
will not go all the way to the `to` and `from` points.
</Note>

2
markdown/dev/reference/api/macros/en.md
View file

@ -17,5 +17,3 @@ Below is a list of macros from [the plugins we maintain](/reference/plugins):
For more info on a specific macro and examples, follow the link to the plugin that provides the macro.
</Tip>

10
markdown/dev/reference/api/macros/flip/en.md
View file

@ -2,7 +2,7 @@
title: flip
---
The `flip` macro flips (mirrors) an entire part vertically around either the X-axis or the Y-axis.
The `flip` macro flips (mirrors) an entire part vertically around either the X-axis or the Y-axis.\
It is provided by the [flip plugin](/reference/plugins/flip).
```js
@ -11,7 +11,7 @@ macro("flip", {
})
```
| Property | Default | Type | Description |
| Property | Default | Type | Description |
|----------------:|---------|---------------------|-------------|
| `axis` | 'x' | The axis to flip around. Either `x` or `y` |
@ -19,8 +19,8 @@ macro("flip", {
Under the hood, this macro will:
- Go through all Points in your Part, and multiply their (X or Y)-coordinate by -1
- Go through all the Paths in your Part, and for each drawing operation will multiply the (X or Y)-coordinare by -1
- Go through all the Snippets in your Part and multiply the (X or Y)-coordinate of the anchor point by -1
- Go through all Points in your Part, and multiply their (X or Y)-coordinate by -1
- Go through all the Paths in your Part, and for each drawing operation will multiply the (X or Y)-coordinare by -1
- Go through all the Snippets in your Part and multiply the (X or Y)-coordinate of the anchor point by -1
</Note>

4
markdown/dev/reference/api/macros/gore/en.md
View file

@ -18,7 +18,7 @@ macro("gore", {
})
```
| Property | Default | Type | Description |
| Property | Default | Type | Description |
|--------------:|---------|------------|----------------------------------------------|
| `from` | | [Point][2] | The point to start drafting the gore from |
| `radius` | | number | The radius of the sphere the gores should cover |
@ -27,6 +27,6 @@ macro("gore", {
| `render` | `false` | boolean | Whether or not to render the generated path |
| `class` | | boolean | Any classes to add to the generated path |
[1]: https://en.wikipedia.org/wiki/Gore_\(segment\)
[1]: https://en.wikipedia.org/wiki/Gore_(segment)
[2]: /reference/api/point

4
markdown/dev/reference/api/macros/grainline/en.md
View file

@ -2,7 +2,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/).
<Example part="plugin_grainline">
@ -16,7 +16,7 @@ macro("grainline", {
})
```
| Property | Default | Type | Description |
| Property | Default | Type | Description |
|------------:|-------------|------------|----------------------------------------------|
| `from` | | [Point][1] | The startpoint of the *grainline* indicator |
| `to` | | [Point][1] | The endpoint of the *grainline* indicator |

9
markdown/dev/reference/api/macros/hd/en.md
View file

@ -2,7 +2,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/).
<Example part="point_dx">
@ -17,7 +17,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 |
@ -31,8 +31,7 @@ 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>

10
markdown/dev/reference/api/macros/ld/en.md
View file

@ -2,7 +2,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/).
<Example part="point_dist">
@ -17,8 +17,7 @@ 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,8 +31,7 @@ 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>

4
markdown/dev/reference/api/macros/miniscale/en.md
View file

@ -18,9 +18,7 @@ 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 |

3
markdown/dev/reference/api/macros/mirror/en.md
View file

@ -33,7 +33,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 |
@ -41,4 +41,3 @@ 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 |

10
markdown/dev/reference/api/macros/pd/en.md
View file

@ -2,7 +2,7 @@
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">
@ -16,7 +16,7 @@ macro('pd', {
})
```
| Property | Default | Type | Description |
| Property | Default | Type | Description |
|----------------:|---------|---------------------|-------------|
| `path` | | [Path](/reference/api/path) | The path to draw the dimension along |
| `d` | 0 | Number | The offset at which to draw the dimension |
@ -29,9 +29,7 @@ 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>

3
markdown/dev/reference/api/macros/rmd/en.md
View file

@ -24,7 +24,6 @@ macro('rmd', {
})
```
| Property | Default | Type | Description |
| Property | Default | Type | Description |
|----------|---------|----------|-------------|
| `id` | | `string` | The id of the dimension to remove |

3
markdown/dev/reference/api/macros/round/en.md
View file

@ -21,7 +21,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 |
@ -30,4 +30,3 @@ 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 |

3
markdown/dev/reference/api/macros/scalebox/en.md
View file

@ -17,7 +17,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 |
@ -26,4 +26,3 @@ macro('scalebox', {
| `rotate` | 0 | Number | Rotation in degrees |
(\*) `freesewingIsMadeByJoostDeCockAndContributors \n withTheFinancialSupportOfOurPatrons`

6
markdown/dev/reference/api/macros/sprinkle/en.md
View file

@ -2,7 +2,7 @@
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">
@ -16,11 +16,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 |
| `scale` | 1 | number | Scale for the individual snippets |
| `rotate` | 0 | number | Rotation for the individual snippets |

5
markdown/dev/reference/api/macros/title/en.md
View file

@ -2,12 +2,12 @@
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">Example of a title added by this macro</Example>
| 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,4 +16,3 @@ 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 |

11
markdown/dev/reference/api/macros/vd/en.md
View file

@ -2,7 +2,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/).
<Example part="point_dy">
@ -17,7 +17,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 |
@ -31,10 +31,7 @@ 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>