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

28
markdown/dev/reference/plugins/flip/en.md
View file

@ -1,22 +1,12 @@
---
title: flip
title: "@freesewing/plugin-flip"
---
[![Build-time plugin](https://img.shields.io/badge/Type-build--time-purple.svg)](/plugins)
 
[![License: MIT](https://img.shields.io/npm/l/@freesewing/plugin-flip.svg?label=License)](https://www.npmjs.com/package/@freesewing/plugin-flip)
 
[![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-flip](https://img.shields.io/github/issues/freesewing/freesewing/pkg:plugin-flip.svg?label=Issues)](https://github.com/freesewing/freesewing/issues?q=is%3Aissue+is%3Aopen+label%3Apkg%3Aplugin-flip)
The **flip** plugin provides [the flip macro](/reference/macros/flip/) which flips (mirrors) an entire part vertically around the Y-axis.
```js
let { macro } = part.shorthand();
macro("flip");
```
The **@freesewing/plugin-flip** plugin provides [the flip
macro](/reference/apis/macros/flip/) which flips (mirrors)
an entire part vertically around the Y-axis.
It's typically used to create a right and left pattern part from
the same basis.
## Installation
@ -26,8 +16,8 @@ npm install @freesewing/plugin-flip
## 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";
@ -37,4 +27,4 @@ import config from "../config";
const Pattern = new freesewing.Design(config, flip);
```
Now you can use [the flip macro](/reference/macros/flip) in your parts.
Now you can use [the flip macro](/reference/api/macros/flip) in your parts.