1
0
Fork 0

fix(markdown): Move caption to children

This commit is contained in:
Joost De Cock 2022-01-19 11:31:39 +01:00
parent 76d13e3fa3
commit 7bebd8cf07
96 changed files with 304 additions and 213 deletions

View file

@ -11,10 +11,9 @@ pattern is generated by FreeSewing.
This illustration is a good starting point to gain a better
understanding of the structure of a FreeSewing pattern:
<Example
part="docs_overview"
caption="A schematic overview of FreeSewing"
/>
<Example part="docs_overview">
A schematic overview of FreeSewing
</Example>
If we look at our image, it can be divided into three areas:
@ -24,7 +23,7 @@ If we look at our image, it can be divided into three areas:
Let's take a closer look at everything that is contained within our central **Pattern** box:
<ReadMore list />
<ReadMore />
<Note>

View file

@ -3,11 +3,9 @@ title: Parts
order: 20
---
<Example
part="docs_overview"
caption="Parts divide your pattern into re-usable components"
options={{focus: "Part"}}
/>
<Example part="docs_overview" options={{focus: "Part"}}>
Parts divide your pattern into re-usable components
</Example>
Parts are a container for the points, paths, and snippets of (a part of) your pattern.
They are also re-usable by other patterns, which makes them a powerful tool to build

View file

@ -3,11 +3,9 @@ title: Paths
order: 40
---
<Example
part="docs_overview"
caption="Paths are the lines and curves of your pattern"
options={{focus: "Paths"}}
/>
<Example part="docs_overview" options={{focus: "Paths"}}>
Paths are the lines and curves of your pattern
</Example>
Paths are the lines and curves that make up your pattern.

View file

@ -3,11 +3,9 @@ title: Pattern
order: 80
---
<Example
part="docs_overview"
caption="The pattern you create will be a constructor for instances of your pattern"
options={{focus: "Pattern"}}
/>
<Example part="docs_overview" options={{focus: "Pattern"}}>
The pattern you create will be a constructor for instances of your pattern
</Example>
Last but not least, we've arrived at the level of the pattern itself.
The pattern is a container that holds all your parts, along with the configuration

View file

@ -3,11 +3,9 @@ title: Points
order: 30
---
<Example
part="docs_overview"
caption="Points store coordinates"
options={{focus: "Points"}}
/>
<Example part="docs_overview" options={{focus: "Points"}}>
Points store coordinates
</Example>
Developing a pattern with FreeSewing is similar to doing it on paper.
But instead of using a pencil and paper, you'll be writing code.

View file

@ -3,11 +3,9 @@ title: Snippets
order: 50
---
<Example
part="docs_overview"
caption="Snippets are little embelishments that go on your pattern"
options={{focus: "Snippets"}}
/>
<Example part="docs_overview" options={{focus: "Snippets"}}>
Snippets are little embelishments that go on your pattern
</Example>
Snippets are little embellishments you can use and re-use on your pattern.
They are typically used for things like logos or buttons.
@ -20,8 +18,7 @@ Each snippet must have:
Since our example image does not have any snippets in it, here's another example
of a `button`, `buttonhole`, and `logo` snippet added to a FreeSewing pattern:
<Example
part="snippet"
caption="An example of the use of snippets"
/>
<Example part="snippet">
An example of the use of snippets
</Example>

View file

@ -3,11 +3,9 @@ title: Store
order: 60
---
<Example
part="docs_overview"
caption="The store provides pattern-wide key/value storage"
options={{focus: "Store"}}
/>
<Example part="docs_overview" options={{focus: "Store"}}>
The store provides pattern-wide key/value storage
</Example>
The store provides key-value storage that is shared across your pattern.

View file

@ -7,7 +7,9 @@ The coordinate system in FreeSewing -- and in SVG -- follows the same rules as t
You start at the top-left, and as you go to the right, the X-coordinate will increase.
As you go down the Y-coordinate will increase.
<Example part="docs_coords" caption="The SVG coordinate system" />
<Example part="docs_coords">
The SVG coordinate system
</Example>
The image above illustrates both the X-axis and Y-axis.
On the X-axis, `20` is further to the right than `10`.