1
0
Fork 0

Revert "chore: Linting for markdown and js"

This reverts commit 1c92e0f655.
This commit is contained in:
joostdecock 2021-10-17 18:26:00 +02:00
parent 994874fa72
commit cba1ab19c8
6627 changed files with 25791 additions and 24211 deletions

View file

@ -1,6 +1,6 @@
***
## title: complete
---
title: complete
---
Set this to `false` to draft a base outline of the pattern, rather than a fully detailed pattern.
This has different uses, such as generating patterns to be cut out with a laser cutter.

View file

@ -1,6 +1,6 @@
***
## title: embed
---
title: embed
---
Set to `true` to make SVG output suitable for embedding in a web page.
@ -20,3 +20,4 @@ let pattern = new brian({
Do **not** use this for SVGs you want to print.
</Warning>

View file

@ -1,9 +1,8 @@
***
---
title: Settings
for: developers
about: Documents all the settings your pattern can receive, including the pattern options, measurmeents, and design options
---------------------------------------------------------------------------------------------------------------------------
---
Settings are what the user passes to your pattern at run-time.

View file

@ -1,6 +1,6 @@
***
## title: idPrefix
---
title: idPrefix
---
Prefixes all IDs in the SVG with the string you pass it. (defaults to `fs-`).

View file

@ -1,23 +1,23 @@
***
## title: layout
---
title: layout
---
Allows you to control the way pattern parts are laid out on the pattern.
There are 3 scenarios:
* layout is truthy: Do layout algorithmically
* layout is falsy: Do not do any layout apart from stacking all parts together
* layout is an object: Layout the parts as detailed in the layout object
- layout is truthy: Do layout algorithmically
- layout is falsy: Do not do any layout apart from stacking all parts together
- layout is an object: Layout the parts as detailed in the layout object
Let's look at each in detail:
##### layout is truthy
This is the default behaviour. Parts will be laid without overlap in
a space that's a small as possible.
This is the default behaviour. Parts will be laid without overlap in
a space that's a small as possible.
Don't expect miracles here.
It's one of those things humans are far better at than
Don't expect miracles here.
It's one of those things humans are far better at than
computers.
##### layout is falsy
@ -57,10 +57,10 @@ let pattern = new brian({
For each part in the `parts` attribute of our layout object, there are 4 possible attributes:
* move: Expects an object with an `x` and `y` property, and will move the part by `x` along the X-axis and by `y` along the Y-axis
* rotate: Expects a number, and will rotate the part by number degrees around its center point
* flipX: Will flip/mirror the part horizontally
* flipY: Will flip/mirror the part vertically
- move: Expects an object with an `x` and `y` property, and will move the part by `x` along the X-axis and by `y` along the Y-axis
- rotate: Expects a number, and will rotate the part by number degrees around its center point
- flipX: Will flip/mirror the part horizontally
- flipY: Will flip/mirror the part vertically
<Note>

View file

@ -1,6 +1,6 @@
***
## title: locale
---
title: locale
---
A 2-letter language code that indicates what language the user wants.

View file

@ -1,13 +1,13 @@
***
---
title: margin
---
## title: margin
Allows you to specify a part margin (in mm). The default is 2mm.\
Allows you to specify a part margin (in mm). The default is 2mm.
Each part will have this margin applied. This means that:
* At the edge of the SVG, the margin will be `margin * 1` (2mm by default)
* Between parts, the margin will be `margin * 2` (4mm by default)
- At the edge of the SVG, the margin will be `margin * 1` (2mm by default)
- Between parts, the margin will be `margin * 2` (4mm by default)
Note that setting the margin to zero (or below) will cause parts to overlap.
```js
@ -22,10 +22,10 @@ let pattern = new brian({
###### For paperless, the minimal margin is 10mm
In paperless mode, the margin will not go below 10mm.
In paperless mode, the margin will not go below 10mm.
That is because text is not taken into account when calculating the bounding box of the part.
Since dimensions are typically the outermost elements in a paperless part,
Since dimensions are typically the outermost elements in a paperless part,
a too narrow margin would cause the dimension text to get cut off.
</Note>

View file

@ -1,6 +1,6 @@
***
## title: measurements
---
title: measurements
---
The measurements to draft for. The pattern configuration lists all required measurements.
@ -14,3 +14,4 @@ let pattern = new brian({
}
})
```

View file

@ -1,6 +1,6 @@
***
## title: only
---
title: only
---
Allows you to specify one or more parts to draft/render, rather than the entire pattern.

View file

@ -1,6 +1,6 @@
***
## title: options
---
title: options
---
The pattern options as specified in the pattern configuration.
@ -15,3 +15,4 @@ let pattern = new brian({
```
<Note>Unlike measurements, options come with defaults.</Note>

View file

@ -1,6 +1,6 @@
***
## title: paperless
---
title: paperless
---
Set this to `true` to draft a paperless pattern. The default is `false`.
@ -11,3 +11,4 @@ let pattern = new brian({
paperless: true
})
```

View file

@ -1,11 +1,12 @@
***
## title: sa
---
title: sa
---
The seam allowance in mm.
Not setting this, setting it to `false`, or to zero, will draft a pattern without seam allowance.
```js
import brian from "@freesewing/brian";

View file

@ -1,6 +1,6 @@
***
## title: units
---
title: units
---
Either `metric` (the default) or `imperial`.