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

54
markdown/dev/reference/plugins/cutonfold/en.md
View file

@ -1,52 +1,20 @@
---
title: cutonfold
title: "@freesewing/plugin-cutonfold"
---
[![Build-time plugin](https://img.shields.io/badge/Type-build--time-purple.svg)](/plugins)
 
[![License: MIT](https://img.shields.io/npm/l/@freesewing/plugin-cutonfold.svg?label=License)](https://www.npmjs.com/package/@freesewing/plugin-cutonfold)
 
[![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-cutonfold](https://img.shields.io/github/issues/freesewing/freesewing/pkg:plugin-cutonfold.svg?label=Issues)](https://github.com/freesewing/freesewing/issues?q=is%3Aissue+is%3Aopen+label%3Apkg%3Aplugin-cutonfold)
The **@freesewing/plugin-cutonfold** plugin provides
[the cutonfold macro](/reference/api/macros/cutonfold) which adds a cut-on-fold
indicator to your design.
The **cutonfold** plugin provides [the cutonfold macro](/reference/macros/cutonfold/):
<Example part="plugin_cutonfold">
<Example part="plugin_cutonfold" caption="An example of the cutonfold macro" design={false} />
An example of the cutonfold macro
```js
let { Point, points, Path, paths, macro } = part.shorthand();
points.topLeft = new Point(0, 0);
points.topRight = new Point(150, 0);
points.bottomRight = new Point(150, 50);
points.bottomLeft = new Point(0, 50);
paths.box = new Path()
.move(points.topLeft)
.line(points.topRight)
.line(points.bottomRight)
.line(points.bottomLeft)
.close();
macro("cutonfold", {
from: points.bottomLeft,
to: points.bottomRight,
grainline: true
});
```
<Note>
###### It's safe to use a corner of your pattern part for this
Since this is typically used on corners, the generated cut-on-fold indicator
will not go all the way to the `to` and `from` points.
</Note>
</Example>
<Tip>
The cutonfold plugin is part of our [plugin-bundle](/reference/plugins/bundle/)
The cutonfold plugin is part of our [plugin-bundle](/reference/plugins/bundle)
</Tip>
@ -58,8 +26,8 @@ npm install @freesewing/plugin-cutonfold
## 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";
@ -69,4 +37,4 @@ import config from "../config";
const Pattern = new freesewing.Design(config, cutonfold);
```
Now you can use [the cutonfold macro](/reference/macros/cutonfold/) in your parts.
Now you can use [the cutonfold macro](/reference/api/macros/cutonfold/) in your parts.