chore(markdown): Move non-api docs to reference
This commit is contained in:
parent
8c3c0c9910
commit
8e9e5052ee
62 changed files with 68 additions and 49 deletions
|
@ -1,21 +0,0 @@
|
|||
---
|
||||
title: complete
|
||||
---
|
||||
|
||||
The `complete` setting controls the level of details that's included on your pattern.
|
||||
This has different uses, such as generating patterns to be cut out with a laser cutter.
|
||||
|
||||
The default `complete` setting is `true`.
|
||||
Set this to `false` to draft a base outline of the pattern, rather than a fully detailed pattern.
|
||||
|
||||
<Note>
|
||||
Setting this to `false` will force [sa](/reference/api/settings/sa) to be set to `false`.
|
||||
</Note>
|
||||
|
||||
```js
|
||||
import Brian from "@freesewing/brian";
|
||||
|
||||
const pattern = new Brian({
|
||||
complete: false
|
||||
})
|
||||
```
|
|
@ -1,14 +0,0 @@
|
|||
---
|
||||
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.
|
||||
|
||||
Don't confuse them with the [pattern configuration](/reference/config/) that is determined by
|
||||
the designer at build-time.
|
||||
|
||||
Below are the supported settings:
|
||||
|
||||
<ReadMore list />
|
|
@ -1,10 +1,9 @@
|
|||
---
|
||||
title: Hooks API
|
||||
for: developers
|
||||
about: Documents the available lifecycle hooks in Core and how to use them
|
||||
title: Lifecycle hooks
|
||||
---
|
||||
|
||||
A **hook** is a lifecycle event.
|
||||
FreeSewing has **lifecycle hooks** that allow you extend its functionality by
|
||||
hooking into a lifecycle event.
|
||||
|
||||
You can register a method for a hook. When the hook is triggered, your method will be
|
||||
called. It will receive two parameters:
|
35
markdown/dev/reference/settings/complete/en.md
Normal file
35
markdown/dev/reference/settings/complete/en.md
Normal file
|
@ -0,0 +1,35 @@
|
|||
---
|
||||
title: complete
|
||||
---
|
||||
|
||||
The `complete` setting controls the level of detail that is included on a
|
||||
pattern. Set `complete` to `false` to limiting the level of detail on the
|
||||
pattern. This has different uses, such as generating patterns to be cut out
|
||||
with a laser cutter.
|
||||
|
||||
## Signature
|
||||
|
||||
```js
|
||||
const settings = {
|
||||
Boolean complete=true
|
||||
}
|
||||
```
|
||||
|
||||
The default `complete` setting is `true`.
|
||||
Set this to `false` to draft a base outline of the pattern, rather than a fully detailed pattern.
|
||||
|
||||
|
||||
## Example
|
||||
```js
|
||||
import Aaron from "@freesewing/aaron"
|
||||
|
||||
const pattern = new Aaron({
|
||||
complete: false
|
||||
})
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
Setting `complete` to `false` will force [sa](/reference/api/settings/sa) to
|
||||
also be set to `false`.
|
||||
|
|
@ -2,26 +2,35 @@
|
|||
title: embed
|
||||
---
|
||||
|
||||
The `embed` setting controls the properties of the SVG document.
|
||||
Set it to `true` to make SVG output suitable for embedding in a web page.
|
||||
The `embed` setting controls the properties of the SVG document. Set it to
|
||||
`true` to make SVG output suitable for embedding in a web page by omitting the
|
||||
`height` and `width` properties.
|
||||
|
||||
## Signature
|
||||
|
||||
```js
|
||||
const settings = {
|
||||
Boolean embed=false
|
||||
}
|
||||
```
|
||||
|
||||
The default for `embed` is `false` which will include the `width` and `height`
|
||||
attributes in the SVG tag, thereby making it suitable for printing.
|
||||
|
||||
When set to `true` the `width` and `height` attributes will not be added
|
||||
which allows you to inject the SVG into an HTML document, where it will
|
||||
responsively scale.
|
||||
When set to `true` the `width` and `height` attributes will not be added which
|
||||
allows you to inject the SVG into an HTML document, where it will responsively
|
||||
scale.
|
||||
|
||||
## Example
|
||||
|
||||
```js
|
||||
import Brian from "@freesewing/brian";
|
||||
import Aaron from "@freesewing/aaron"
|
||||
|
||||
const pattern = new Brian({
|
||||
const pattern = new Aaron({
|
||||
embed: true
|
||||
})
|
||||
```
|
||||
|
||||
<Warning>
|
||||
## Notes
|
||||
|
||||
Do **not** use this for SVGs you want to print.
|
||||
|
||||
</Warning>
|
11
markdown/dev/reference/settings/en.md
Normal file
11
markdown/dev/reference/settings/en.md
Normal file
|
@ -0,0 +1,11 @@
|
|||
---
|
||||
title: Settings
|
||||
about: Documents all the settings your pattern can receive, including the pattern options, measurements, and design options
|
||||
---
|
||||
|
||||
FreeSewing is all about parametric design, and the settings are the parameters we pass to a pattern when drafting it.
|
||||
Perhaps the most important of all settings are the measurements, but there's other settings too.
|
||||
|
||||
Below is a complete list of all supported settings:
|
||||
|
||||
<ReadMore list />
|
Loading…
Add table
Add a link
Reference in a new issue