VSinerva/freesewing
1
0
Fork 0
Code Activity

chore(markdown): Updated Plugin docs for v3

Browse source
This commit is contained in:
Joost De Cock 2022-10-02 00:27:09 +02:00
parent 0374b04a59
commit d988f11062
24 changed files with 329 additions and 606 deletions
Download patch file Download diff file Expand all files Collapse all files

37
markdown/dev/reference/plugins/notches/en.md
View file

@ -2,41 +2,24 @@
title: "@freesewing/plugin-notches"
---
The **@freesewing/plugin-notches** plugin provides the following [snippets](/reference/api/snippets):
- [notch](/reference/api/snippets/notch)
- [bnotch](/reference/api/snippets/bnotch)
<Example part="plugin_notches">
An example of the notch and bnotch snippets
</Example>
<Tip>
The notches plugin is part of our [plugin-bundle](/reference/plugins/bundle)
</Tip>
Published as [@freesewing/plugin-notches][1], this plugin provides the
[notch](/reference/api/snippets/notch) and
[bnotch](/reference/api/snippets/bnotch) snippets.
## Installation
```bash
```sh
npm install @freesewing/plugin-notches
```
## Usage
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:
Either [add it as a part plugins](/reference/api/part/config/plugins) in your
design, or [add it to a pattern instance with
Pattern.use()](/reference/api/pattern/use).
```js
import freesewing from "@freesewing/core";
import notches from "@freesewing/plugin-notches";
import config from "../config";
## Notes
const Pattern = new freesewing.Design(config, notches);
```
The notches plugin is part of our [plugin-bundle](/reference/plugins/bundle)
Now you can use the
[notch](/reference/api/snippets/notch) and
[bnotch](/reference/api/snippets/buttonhole)
snippets in your designs.
[1]: https://www.npmjs.com/package/@freesewing/plugin-notches