Revert "chore: Linting for markdown and js"
This reverts commit 1c92e0f655
.
This commit is contained in:
parent
994874fa72
commit
cba1ab19c8
6627 changed files with 25791 additions and 24211 deletions
|
@ -1,18 +1,18 @@
|
|||
***
|
||||
|
||||
---
|
||||
title: Configuration
|
||||
order: 60
|
||||
---------
|
||||
---
|
||||
|
||||
\<Example
|
||||
part="docs\_overview"
|
||||
caption="The pattern configuration holds important information about the pattern"
|
||||
options={{focus: "config"}}
|
||||
<Example
|
||||
part="docs_overview"
|
||||
caption="The pattern configuration holds important information about the pattern"
|
||||
options={{focus: "config"}}
|
||||
/>
|
||||
|
||||
A pattern's [configuration](/reference/config/) is created by the pattern designer
|
||||
and details a number of important things about the pattern, like:
|
||||
|
||||
* The measurements that are required to draft the pattern
|
||||
* The different parts in the pattern and how they depend on each other
|
||||
* The different options that are available to tweak the pattern
|
||||
- The measurements that are required to draft the pattern
|
||||
- The different parts in the pattern and how they depend on each other
|
||||
- The different options that are available to tweak the pattern
|
||||
|
||||
|
|
|
@ -1,31 +1,28 @@
|
|||
***
|
||||
|
||||
---
|
||||
title: Pattern guide
|
||||
order: 200
|
||||
for: contributors
|
||||
icons:
|
||||
icons:
|
||||
- blocks
|
||||
- pattern
|
||||
about: |
|
||||
Learn about the main building blocks that make up a FreeSewing pattern
|
||||
goals:
|
||||
- Learn about points
|
||||
- Learn about paths
|
||||
- Learn about snippets
|
||||
- Learn about parts
|
||||
- Learn about the pattern configuration
|
||||
- Learn about the pattern store
|
||||
- Learn about the pattern itself
|
||||
---
|
||||
|
||||
* blocks
|
||||
* pattern
|
||||
about: |
|
||||
Learn about the main building blocks that make up a FreeSewing pattern
|
||||
goals:
|
||||
* Learn about points
|
||||
* Learn about paths
|
||||
* Learn about snippets
|
||||
* Learn about parts
|
||||
* Learn about the pattern configuration
|
||||
* Learn about the pattern store
|
||||
* Learn about the pattern itself
|
||||
|
||||
***
|
||||
|
||||
This illustration is a good starting point to gain a better
|
||||
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"
|
||||
part="docs_overview"
|
||||
caption="A schematic overview of FreeSewing"
|
||||
/>
|
||||
|
||||
As you learn more about FreeSewing, you'll discover that there's more
|
||||
|
@ -33,9 +30,9 @@ to this picture than meets the eye. So let's get started.
|
|||
|
||||
If we look at our image, it can can divided into three areas:
|
||||
|
||||
* The left area with the *settings* box
|
||||
* The middle area with the *Pattern* box and everything in it
|
||||
* The right area with the *draft* box and the *SVG* and *React* logos
|
||||
- The left area with the *settings* box
|
||||
- The middle area with the *Pattern* box and everything in it
|
||||
- The right area with the *draft* box and the *SVG* and *React* logos
|
||||
|
||||
<Note>
|
||||
|
||||
|
@ -50,3 +47,5 @@ That part is outside the scope of this text.
|
|||
Let's take a closer look at everything that is contained within our central *Pattern* box:
|
||||
|
||||
<ReadMore list />
|
||||
|
||||
|
||||
|
|
|
@ -1,21 +1,21 @@
|
|||
***
|
||||
|
||||
---
|
||||
title: Parts
|
||||
order: 40
|
||||
---------
|
||||
---
|
||||
|
||||
\<Example
|
||||
part="docs\_overview"
|
||||
caption="Parts divide your pattern into re-usable components"
|
||||
options={{focus: "Part"}}
|
||||
<Example
|
||||
part="docs_overview"
|
||||
caption="Parts divide your pattern into re-usable components"
|
||||
options={{focus: "Part"}}
|
||||
/>
|
||||
|
||||
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
|
||||
They are also re-usable by other patterns, which makes them a powerful tool to build
|
||||
a pattern library.
|
||||
|
||||
If you design a T-shirt pattern with a `front`, `back`, and `sleeve`, each of those would be a part.
|
||||
If you then wanted to make a long-sleeved version of your T-shirt pattern, you only need to design
|
||||
If you then wanted to make a long-sleeved version of your T-shirt pattern, you only need to design
|
||||
a new sleeve part. You can re-use the `front` and `back` parts of your short-sleeved T-shirt pattern, as they did not change.
|
||||
|
||||
When developing a FreeSewing pattern, you will spend most of your time designing the individual parts.
|
||||
|
||||
|
|
|
@ -1,13 +1,12 @@
|
|||
***
|
||||
|
||||
---
|
||||
title: Paths
|
||||
order: 20
|
||||
---------
|
||||
---
|
||||
|
||||
\<Example
|
||||
part="docs\_overview"
|
||||
caption="Paths are the lines and curves of your pattern"
|
||||
options={{focus: "Paths"}}
|
||||
<Example
|
||||
part="docs_overview"
|
||||
caption="Paths are the lines and curves of your pattern"
|
||||
options={{focus: "Paths"}}
|
||||
/>
|
||||
|
||||
Paths are the lines and curves that make up your pattern.
|
||||
|
@ -15,15 +14,15 @@ Paths are the lines and curves that make up your pattern.
|
|||
They are made up of a set of drawing operations that together make up the path.
|
||||
FreeSewing supports the following types of drawing operations:
|
||||
|
||||
* The **move** operation moves our virtual pen but does not draw anything.
|
||||
* The **line** operation draws a straight line
|
||||
* The **curve** operation draws a [Bézier curve](/guides/overview/about/beziercurves/)
|
||||
* The **close** operation closes the path
|
||||
- The **move** operation moves our virtual pen but does not draw anything.
|
||||
- The **line** operation draws a straight line
|
||||
- The **curve** operation draws a [Bézier curve](/guides/overview/about/beziercurves/)
|
||||
- The **close** operation closes the path
|
||||
|
||||
To crucial thing to keep in mind is that, with the exception of the **move** operation,
|
||||
all drawing operations start from wherever you are currently on your virtual sheet of paper.
|
||||
|
||||
For example, you might expect the **line** operation to take a start- and endpoint.
|
||||
For example, you might expect the **line** operation to take a start- and endpoint.
|
||||
But in fact, it only takes and endpoint, and will draw a straight line from where our virtual pen
|
||||
currently is to said endpoint.
|
||||
|
||||
|
@ -38,7 +37,8 @@ Understanding that each drawing operation builds upon the next one is an importa
|
|||
|
||||
<Tip>
|
||||
|
||||
Our example image (which, if you hadn't realized was created with FreeSewing) has a lot of
|
||||
Our example image (which, if you hadn't realized was created with FreeSewing) has a lot of
|
||||
paths in it. Each box, the arrows, the lines in the React logo, and so on.
|
||||
|
||||
</Tip>
|
||||
|
||||
|
|
|
@ -1,13 +1,12 @@
|
|||
***
|
||||
|
||||
---
|
||||
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"
|
||||
caption="The pattern you create will be a constructor for instances of your pattern"
|
||||
options={{focus: "Pattern"}}
|
||||
/>
|
||||
|
||||
Last but not least, we've arrived at the level of the pattern itself.
|
||||
|
@ -17,6 +16,7 @@ and the store.
|
|||
In reality, your pattern will be a *constructor* that takes the user's settings as
|
||||
input and will return a new instance of your pattern.
|
||||
|
||||
That pattern instance will have a `draft()` method which will do the actual work of
|
||||
drafting the pattern. Once drafted, you can either call the `render()` method on
|
||||
That pattern instance will have a `draft()` method which will do the actual work of
|
||||
drafting the pattern. Once drafted, you can either call the `render()` method on
|
||||
the pattern instance, or pass it to [our React component](/packages/components) to render it in the browser.
|
||||
|
||||
|
|
|
@ -1,13 +1,12 @@
|
|||
***
|
||||
|
||||
---
|
||||
title: Points
|
||||
order: 10
|
||||
---------
|
||||
---
|
||||
|
||||
\<Example
|
||||
part="docs\_overview"
|
||||
caption="Points store coordinates"
|
||||
options={{focus: "Points"}}
|
||||
<Example
|
||||
part="docs_overview"
|
||||
caption="Points store coordinates"
|
||||
options={{focus: "Points"}}
|
||||
/>
|
||||
|
||||
Developing a pattern with FreeSewing is similar to doing it on paper.
|
||||
|
@ -17,24 +16,25 @@ Before we can draw any line, we need to know where it starts from, and where it
|
|||
That's why we have **points**. They are the most basic building block of a
|
||||
FreeSewing pattern, and their role is to store coordinates.
|
||||
|
||||
Each point must have:
|
||||
Each point must have:
|
||||
|
||||
* A **X-coordinate**
|
||||
* A **Y-coordinate**
|
||||
- A **X-coordinate**
|
||||
- A **Y-coordinate**
|
||||
|
||||
Together, these coordinates determine the location of the point in the 2-dimensional plane we're drawing on.
|
||||
|
||||
<Note>
|
||||
|
||||
Points are unlikely to confuse you. The only gotcha is [the
|
||||
coordinate system](/guides/prerequisites/coordinate-system/) which has a Y-axis that is inverted to what you
|
||||
coordinate system](/guides/prerequisites/coordinate-system/) which has a Y-axis that is inverted to what you
|
||||
may intuitively expect.
|
||||
|
||||
</Note>
|
||||
|
||||
<Tip>
|
||||
|
||||
Our example image (which, if you hadn't realized was created with FreeSewing) has a lot of
|
||||
Our example image (which, if you hadn't realized was created with FreeSewing) has a lot of
|
||||
points in it. The corners of the boxes, the location where the text goes, and so on.
|
||||
|
||||
</Tip>
|
||||
|
||||
|
|
|
@ -1,27 +1,27 @@
|
|||
***
|
||||
|
||||
---
|
||||
title: Snippets
|
||||
order: 20
|
||||
---------
|
||||
---
|
||||
|
||||
\<Example
|
||||
part="docs\_overview"
|
||||
caption="Snippets are little embelishments that go on your pattern"
|
||||
options={{focus: "Snippets"}}
|
||||
<Example
|
||||
part="docs_overview"
|
||||
caption="Snippets are little embelishments that go on your pattern"
|
||||
options={{focus: "Snippets"}}
|
||||
/>
|
||||
|
||||
Snippets are little embellishments you can use and re-use on your pattern.
|
||||
They are typically used for things like logos or buttons.
|
||||
They are typically used for things like logos or buttons.
|
||||
|
||||
Each snippet must have:
|
||||
|
||||
* An anchor point that determine where the snippet will be located
|
||||
* The name of the snippet to insert
|
||||
- An anchor point that determine where the snippet will be located
|
||||
- The name of the snippet to insert
|
||||
|
||||
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"
|
||||
part="snippet"
|
||||
caption="An example of the use of snippets"
|
||||
/>
|
||||
|
||||
|
|
|
@ -1,16 +1,16 @@
|
|||
***
|
||||
|
||||
---
|
||||
title: Store
|
||||
order: 70
|
||||
---------
|
||||
---
|
||||
|
||||
\<Example
|
||||
part="docs\_overview"
|
||||
caption="The store provides pattern-wide key/value storage"
|
||||
options={{focus: "Store"}}
|
||||
<Example
|
||||
part="docs_overview"
|
||||
caption="The store provides pattern-wide key/value storage"
|
||||
options={{focus: "Store"}}
|
||||
/>
|
||||
|
||||
The store provides key-value storage that is shared across your pattern.
|
||||
|
||||
If you have some information in one part that you want to make available
|
||||
outside that part (in another part) you can save it to the store.
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue