VSinerva/freesewing
1
0
Fork 0
Code Activity
freesewing/markdown/dev/reference/macros/bartack/en.md

55 lines
1.4 KiB
Markdown
Raw Normal View History

Revert "chore: Linting for markdown and js" This reverts commit 1c92e0f655c1b34e4b1f6807914529cc4d82ff81.
2021-10-17 18:26:00 +02:00
---
title: bartack
---
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown
2021-08-25 16:09:31 +02:00
chore(markdown): Work on macro reference docs
2022-09-30 01:45:37 +02:00
The `bartack` macro allows you to add a _bartack_ marker to your sewing
pattern. It is provided by the [bartack plugin](/reference/plugins/bartack/).
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown
2021-08-25 16:09:31 +02:00
chore(markdown): Work on macro reference docs
2022-09-30 01:45:37 +02:00
## Signature
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown
2021-08-25 16:09:31 +02:00
```js
chore(markdown): Work on macro reference docs
2022-09-30 01:45:37 +02:00
macro('banner', {
Point anchor,
Number angle=0,
Number density=3,
Number length=15,
String prefix='',
String suffix='',
Number width=3,
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown
2021-08-25 16:09:31 +02:00
})
```
chore(markdown): Work on macro reference docs
2022-09-30 01:45:37 +02:00
## Example
<Example caption="Example of the bartack macro">
```js
({ macro, Point, part }) => {
macro('bartack', {
anchor: new Point(0,0),
length: 25
})
return part
}
```
</Example>
## Configuration
chore(markdown): Linting of dev docs
2022-02-19 08:04:25 +01:00
| Property | Default | Type | Description |
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown
2021-08-25 16:09:31 +02:00
|-------------:|------------|------------|-------------|
fix(markdown): Added missing anchor prop
2022-01-16 17:27:58 +01:00
| `anchor` | | `Point` | The point to start the bartack from |
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown
2021-08-25 16:09:31 +02:00
| `angle` | `0` | `number` | The angle under which to draw the bartack |
| `density` | `3` | `number` | Controls how close the stitches are togeter |
| `length` | `15` | `number` | Length of the bartack |
fix(docs): Updates to macros documentation
2022-12-09 20:59:53 -08:00
| `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 |
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown
2021-08-25 16:09:31 +02:00
| `width` | `3` | `number` | Width of the bartack |
fix(docs): Updates to macros documentation
2022-12-09 20:59:53 -08:00
## Result
| Generated Element | Description |
|-------------------|-------------|
| `paths.${prefix}bartack${suffix}` | Path generated for the bartack marker |
Copy permalink