VSinerva/freesewing
1
0
Fork 0
Code Activity

chore(markdown): Restructuring dev docs

Browse source
This commit is contained in:
Joost De Cock 2021-12-27 17:33:49 +01:00
parent 9ef46c502a
commit d42d9a9377
114 changed files with 246 additions and 1462 deletions
Download patch file Download diff file Expand all files Collapse all files

29
markdown/dev/reference/plugins/bartack/en.md
View file

@ -1,27 +1,26 @@
---
title: bartack
title: "@freesewing/plugin-bartack"
---
[![Build-time plugin](https://img.shields.io/badge/Type-build--time-purple.svg)](/plugins)
 
[![License: MIT](https://img.shields.io/npm/l/@freesewing/plugin-bartack.svg?label=License)](https://www.npmjs.com/package/@freesewing/plugin-bartack)
 
[![Code quality on DeepScan](https://deepscan.io/api/teams/2114/projects/2993/branches/23256/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=2114&pid=2993&bid=23256)
 
[![Open issues tagged pkg:plugin-bartack](https://img.shields.io/github/issues/freesewing/freesewing/pkg:plugin-bartack.svg?label=Issues)](https://github.com/freesewing/freesewing/issues?q=is%3Aissue+is%3Aopen+label%3Apkg%3Aplugin-bartack)
The **@freesewing/plugin-bartack** plugin provides
[the bartack macro](/reference/api/macros/bartack).
This macro allows you to add bartacks — a set of
tight zig-zag stitches used to enforce a seam — to your design.
The [@freesewing/plugin-bartack](/reference/packages/plugin-bartack) packages provides a plugin to help bartack points and/or paths around a given bartack line.
## Example
<Example part="plugin_bartack">Example of the bartack macro provided by this plugin</Example>
## Installation
```bash
```sh
npm install @freesewing/plugin-bartack
```
## Usage
Like all [build-time plugins](/guides/plugins/#build-time-plugins), you load them
by passing them to the [`freesewing.Design`](/reference/api#design) constructor:
Like all [build-time plugins](/guides/plugins/types-of-plugins#build-time-plugins), you
load them by passing them to the [freesewing.Design](/reference/api/design) super-constructor:
```js
import freesewing from "@freesewing/core";
@ -32,8 +31,8 @@ const Pattern = new freesewing.Design(config, bartack);
```
Now you can use the
[bartack](/reference/macros/bartack/),
[bartackAlong](/reference/macros/bartackalong/), and
[bartackFractionAlong](/reference/macros/bartackfractionalong/) macros in your parts.
[bartack](/reference/api/macros/bartack/),
[bartackAlong](/reference/api/macros/bartackalong/), and
[bartackFractionAlong](/reference/api/macros/bartackfractionalong/) macros in your parts: