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

33
markdown/dev/reference/plugins/mirror/en.md
View file

@ -1,36 +1,25 @@
---
title: "@freesewing/plugin-mirror"
title: plugin-mirror
---
The **@freesewing/plugin-mirror** plugin provides [the mirror
macro](/reference/api/macros/mirror) which facilitates mirroring
a number of points and/or paths around a given mirror line.
<Example part="plugin_mirror">Example of the mirror plugin</Example>
<Tip>
The mirror plugin is part of our [plugin-bundle](/reference/plugins/bundle)
</Tip>
Published as [@freesewing/plugin-mirror][1], this plugin provides [the mirror
macro](/reference/api/macros/mirror) which facilitates mirroring a number of
points and/or paths around a given mirror line.
## Installation
```bash
```sh
npm install @freesewing/plugin-mirror
```
## 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 mirror from "@freesewing/plugin-mirror";
import config from "../config";
## Notes
const Pattern = new freesewing.Design(config, mirror);
```
The mirror plugin is part of our [plugin-bundle](/reference/plugins/bundle)
You can now use the [mirror](/reference/api/macros/mirror) macro in your parts.
[1]: https://www.npmjs.com/package/@freesewing/plugin-mirror