chore(markdown): Restructuring dev docs
This commit is contained in:
parent
9ef46c502a
commit
d42d9a9377
114 changed files with 246 additions and 1462 deletions
35
markdown/dev/reference/api/macros/cutonfold/en.md
Normal file
35
markdown/dev/reference/api/macros/cutonfold/en.md
Normal file
|
@ -0,0 +1,35 @@
|
|||
---
|
||||
title: cutonfold
|
||||
---
|
||||
|
||||
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" />
|
||||
|
||||
```js
|
||||
macro('cutonfold', {
|
||||
from: points.cofLeft,
|
||||
to: points.cofRight,
|
||||
grainline: true
|
||||
}
|
||||
```
|
||||
|
||||
| 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 |
|
||||
|
||||
<Note>
|
||||
|
||||
###### 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
|
||||
will not go all the way to the `to` and `from` points.
|
||||
|
||||
</Note>
|
||||
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue