chore: Port FreeSewing.dev to docusaurus
The replaces the NextJS site powering FreeSewing.dev with a Docusaurus setup. It's part of my efforts to simplify FreeSewing's setup so we can focus on our core value proposition.
This commit is contained in:
parent
497633d1d3
commit
ab3204f9f1
692 changed files with 11037 additions and 20674 deletions
66
sites/dev/docs/reference/macros/bartackalong/readme.mdx
Normal file
66
sites/dev/docs/reference/macros/bartackalong/readme.mdx
Normal file
|
@ -0,0 +1,66 @@
|
|||
---
|
||||
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 [plugin-annotations](/reference/plugins/annotations), which is
|
||||
part of [core-plugins](/reference/plugins/core) (so it is available by default).
|
||||
|
||||
## Signature
|
||||
|
||||
```js
|
||||
macro('bartackAlong', {
|
||||
String id='bartack'
|
||||
Number angle=0,
|
||||
Number density=3,
|
||||
Number length=15,
|
||||
Path path,
|
||||
String prefix='',
|
||||
String suffix='',
|
||||
Number width=3,
|
||||
Boolean force = false,
|
||||
})
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
<Example caption="Example of the bartackAlong macro">
|
||||
```js
|
||||
({ Point, Path, macro, part }) => {
|
||||
|
||||
macro('bartackAlong', {
|
||||
path: new Path()
|
||||
.move(new Point(15,15))
|
||||
.curve(
|
||||
new Point(20, 20),
|
||||
new Point(30, 20),
|
||||
new Point(35, 15),
|
||||
)
|
||||
})
|
||||
|
||||
return part
|
||||
}
|
||||
```
|
||||
</Example>
|
||||
|
||||
## Configuration
|
||||
|
||||
| Property | Default | Type | Description |
|
||||
|-------------:|------------|------------|-------------|
|
||||
| `angle` | `0` | `number` | The angle under which to draw the bartack |
|
||||
| `density` | `3` | `number` | Controls how close the stitches are together |
|
||||
| `id` | `bartackalong` | `string` | The ID of this macro instance |
|
||||
| `length` | `15` | `number` | Length of the bartack |
|
||||
| `path` | | `Path` | The path the bartack should follow |
|
||||
| `prefix` | | `string` | A prefix to apply to the name of the generated path |
|
||||
| `suffix` | | `string` | A suffix to apply to the name of the generated path |
|
||||
| `width` | `3` | `number` | Width of the bartack |
|
||||
| `force` | `false` | `boolean` | Set this to `true` to display the macro output even when `complete` is `false` |
|
||||
|
||||
## Notes
|
||||
|
||||
This macro takes the `complete` setting into account and won't output anything when both complete and `force` are `false`.
|
||||
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue