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

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

@ -1,16 +1,12 @@
---
title: mirror
title: "@freesewing/plugin-mirror"
---
[![Build-time plugin](https://img.shields.io/badge/Type-build--time-purple.svg)](/plugins)
 
[![License: MIT](https://img.shields.io/npm/l/@freesewing/plugin-mirror.svg?label=License)](https://www.npmjs.com/package/@freesewing/plugin-mirror)
 
[![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-mirror](https://img.shields.io/github/issues/freesewing/freesewing/pkg:plugin-mirror.svg?label=Issues)](https://github.com/freesewing/freesewing/issues?q=is%3Aissue+is%3Aopen+label%3Apkg%3Aplugin-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.
The [@freesewing/plugin-mirror](/reference/packages/plugin-mirror) packages provides a plugin to help mirror points and/or paths around a given mirror line.
<Example part="plugin_mirror">Example of the mirror plugin</Example>
## Installation
@ -20,8 +16,8 @@ npm install @freesewing/plugin-mirror
## 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";
@ -31,6 +27,6 @@ import config from "../config";
const Pattern = new freesewing.Design(config, mirror);
```
Now you can use [the mirror macro](/reference/macros/mirror) in your parts.
You can now use the [mirror](/reference/api/macros/mirror) macro in your parts.