chore(markdown): Restructuring dev docs
This commit is contained in:
parent
9ef46c502a
commit
d42d9a9377
114 changed files with 246 additions and 1462 deletions
15
markdown/dev/reference/api/snippets/bnotch/en.md
Normal file
15
markdown/dev/reference/api/snippets/bnotch/en.md
Normal file
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
title: bnotch
|
||||
---
|
||||
|
||||
The `bnotch` snippet is intended for notches at the back, or when you
|
||||
need an alternative to the default `notch`.
|
||||
|
||||
It is provided by [plugin-theme](/reference/plugins/theme/).
|
||||
|
||||
```js
|
||||
snippets.demo = new Snippet('bnotch', points.anchor)
|
||||
```
|
||||
|
||||
<Example part="snippets_bnotch">An example of the bnotch snippet</Example>
|
||||
|
13
markdown/dev/reference/api/snippets/button/en.md
Normal file
13
markdown/dev/reference/api/snippets/button/en.md
Normal file
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
title: button
|
||||
---
|
||||
|
||||
The `button` snippet is used to mark button placement and is
|
||||
provided by [plugin-buttons](/reference/plugins/buttons/).
|
||||
|
||||
```js
|
||||
snippets.demo = new Snippet('button', points.anchor)
|
||||
```
|
||||
|
||||
<Example part="snippets_button" caption="An example of the button snippet" />
|
||||
|
24
markdown/dev/reference/api/snippets/buttonhole-end/en.md
Normal file
24
markdown/dev/reference/api/snippets/buttonhole-end/en.md
Normal file
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
title: buttonhole-end
|
||||
---
|
||||
|
||||
The `buttonhole-end` snippet is used to mark buttonhole placement and is
|
||||
provided by [plugin-buttons](/reference/plugins/buttons/).
|
||||
|
||||
```js
|
||||
snippets.demo = new Snippet('buttonhole-end', points.anchor)
|
||||
```
|
||||
|
||||
<Example part="snippets_buttonhole_end" caption="An example of the buttonhole-end snippet" />
|
||||
|
||||
<Note>
|
||||
|
||||
##### Aligning your buttons and buttonholes
|
||||
|
||||
We provide three buttonhole snippets with a different alignment:
|
||||
|
||||
- [buttonhole](/reference/snippets/buttonhole/): Anchor point is the middle of the buttonhole
|
||||
- [buttonhole-start](/reference/snippets/buttonhole-start/): Anchor point is the start of the buttonhole
|
||||
- [buttonhole-end](/reference/snippets/buttonhole-end/): Anchor point is the end of the buttonhole
|
||||
|
||||
</Note>
|
24
markdown/dev/reference/api/snippets/buttonhole-start/en.md
Normal file
24
markdown/dev/reference/api/snippets/buttonhole-start/en.md
Normal file
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
title: buttonhole-start
|
||||
---
|
||||
|
||||
The `buttonhole-start` snippet is used to mark buttonhole placement and is
|
||||
provided by [plugin-buttons](/reference/plugins/buttons/).
|
||||
|
||||
```js
|
||||
snippets.demo = new Snippet('buttonhole-start', points.anchor)
|
||||
```
|
||||
|
||||
<Example part="snippets_buttonhole_start" caption="An example of the buttonhole-start snippet" />
|
||||
|
||||
<Note>
|
||||
|
||||
##### Aligning your buttons and buttonholes
|
||||
|
||||
We provide three buttonhole snippets with a different alignment:
|
||||
|
||||
- [buttonhole](/reference/snippets/buttonhole/): Anchor point is the middle of the buttonhole
|
||||
- [buttonhole-start](/reference/snippets/buttonhole-start/): Anchor point is the start of the buttonhole
|
||||
- [buttonhole-end](/reference/snippets/buttonhole-end/): Anchor point is the end of the buttonhole
|
||||
|
||||
</Note>
|
25
markdown/dev/reference/api/snippets/buttonhole/en.md
Normal file
25
markdown/dev/reference/api/snippets/buttonhole/en.md
Normal file
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
title: buttonhole
|
||||
---
|
||||
|
||||
The `buttonhole` snippet is used to mark buttonhole placement and is
|
||||
provided by [plugin-buttons](/reference/plugins/buttons/).
|
||||
|
||||
```js
|
||||
snippets.demo = new Snippet('buttonhole', points.anchor)
|
||||
```
|
||||
|
||||
<Example part="snippets_buttonhole" caption="An example of the buttonhole snippet" />
|
||||
|
||||
<Note>
|
||||
|
||||
##### Aligning your buttons and buttonholes
|
||||
|
||||
We provide three buttonhole snippets with a different alignment:
|
||||
|
||||
- [buttonhole](/reference/snippets/buttonhole/): Anchor point is the middle of the buttonhole
|
||||
- [buttonhole-start](/reference/snippets/buttonhole-start/): Anchor point is the start of the buttonhole
|
||||
- [buttonhole-end](/reference/snippets/buttonhole-end/): Anchor point is the end of the buttonhole
|
||||
|
||||
</Note>
|
||||
|
9
markdown/dev/reference/api/snippets/en.md
Normal file
9
markdown/dev/reference/api/snippets/en.md
Normal file
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: Snippets
|
||||
for: developers
|
||||
about: Complete list of all the available snippets
|
||||
---
|
||||
|
||||
Snippets are provided by plugins. Follow the links below for more info on and an example of a specific snippet:
|
||||
|
||||
<ReadMore list />
|
13
markdown/dev/reference/api/snippets/logo/en.md
Normal file
13
markdown/dev/reference/api/snippets/logo/en.md
Normal file
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
title: logo
|
||||
---
|
||||
|
||||
The `logo` snippet inserts the FreeSewing logo. It is
|
||||
provided by [plugin-logo](/reference/plugins/logo/).
|
||||
|
||||
```js
|
||||
snippets.demo = new Snippet('logo', points.anchor)
|
||||
```
|
||||
|
||||
<Example part="snippets_logo" caption="An example of the logo snippet" />
|
||||
|
12
markdown/dev/reference/api/snippets/notch/en.md
Normal file
12
markdown/dev/reference/api/snippets/notch/en.md
Normal file
|
@ -0,0 +1,12 @@
|
|||
---
|
||||
title: notch
|
||||
---
|
||||
|
||||
The `notch` snippet is intended for notches and is
|
||||
provided by [plugin-theme](/reference/plugins/theme/).
|
||||
|
||||
```js
|
||||
snippets.demo = new Snippet('bnotch', points.anchor)
|
||||
```
|
||||
<Example part="snippets_notch" caption="An example of the notch snippet" />
|
||||
|
14
markdown/dev/reference/api/snippets/snap-socket/en.md
Normal file
14
markdown/dev/reference/api/snippets/snap-socket/en.md
Normal file
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
title: snap-socket
|
||||
---
|
||||
|
||||
The `snap-socket` snippet is used to mark the socket part of a snap button.
|
||||
|
||||
It is provided by [plugin-buttons](/reference/plugins/buttons/).
|
||||
|
||||
```js
|
||||
snippets.demo = new Snippet('snap-socket', points.anchor)
|
||||
```
|
||||
|
||||
<Example part="snippets_snapsocket" caption="An example of the snap-socket snippet" />
|
||||
|
14
markdown/dev/reference/api/snippets/snap-stud/en.md
Normal file
14
markdown/dev/reference/api/snippets/snap-stud/en.md
Normal file
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
title: snap-stud
|
||||
---
|
||||
|
||||
The `snap-stud` snippet is used to mark the stud part of a snap button.
|
||||
|
||||
It is provided by [plugin-buttons](/reference/plugins/buttons/).
|
||||
|
||||
```js
|
||||
snippets.demo = new Snippet('snap-stud', points.anchor)
|
||||
```
|
||||
|
||||
<Example part="snippets_snapstud" caption="An example of the snap-stud snippet" />
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue