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,23 +1,22 @@
***
---
title: Bézier curves
order: 50
---------
---
While lines on computers are easy to store with a start and end point,
While lines on computers are easy to store with a start and end point,
curves require more information.
In FreeSewing — as in SVG and countless of other applications —\
In FreeSewing — as in SVG and countless of other applications —
curves are stored as Bézier curves. They have:
* A start point
* A first control point thats linked to the start point
* A second control point thats linked to the end point
* An end point
- A start point
- A first control point thats linked to the start point
- A second control point thats linked to the end point
- An end point
\<Example settings={{complete: false}} part="path\_curve" caption="An example of a Bézier curve drawn by the Path.curve() method" />
<Example settings={{complete: false}} part="path_curve" caption="An example of a Bézier curve drawn by the Path.curve() method" />
Bézier curves and their *handles* or *control points* are surprisingly intuitive.
Bézier curves and their *handles* or *control points* are surprisingly intuitive.
The following illustration does a great job at explaining how they are constructed:
![How Bézier curves are constructed](bezier.gif)
@ -26,10 +25,11 @@ The following illustration does a great job at explaining how they are construct
###### More on Bézier curves
Wikipedia has a good [introduction to Bézier curves](https://pomax.github.io/bezierinfo/).\
Wikipedia has a good [introduction to Bézier curves](https://pomax.github.io/bezierinfo/).
For a deep-dive into the subject, check out [A Primer on Bézier Curves](https://pomax.github.io/bezierinfo/) by Pomax.
Note that you don't need understand the mathematics behind Bézier Curves.
Note that you don't need understand the mathematics behind Bézier Curves.
As long as you intuitively *get* how the control points influence the curve, you're good to go.
</Note>

View file

@ -1,16 +1,15 @@
***
---
title: Coordinate system
order: 30
---------
---
In FreeSewing -- and in SVG -- coordinates are like text in a book.
You start at the top on the left side, and going to the right
In FreeSewing -- and in SVG -- coordinates are like text in a book.
You start at the top on the left side, and going to the right
and downwards means going ahead.
<Example part="docs_coords" caption="The SVG coordinate system" />
Which means that on the X-axis, `20` is further to the right than `10`.\
Which means that on the X-axis, `20` is further to the right than `10`.
Likewise, on the Y-axis, `50` is lower than `20`.
<Note>
@ -22,3 +21,4 @@ This is a common point of confusion so keep in mind that the Y-axis may
not behave as you would have intuitively expected.
</Note>

View file

@ -1,25 +1,22 @@
***
---
title: Prerequisites
order: 100
for: developers
icons:
* start
* pattern
about: |
A guide to go over a few things you should know when you start working with our core library
goals:
* Understand that FreeSewing provides parametric pattern design
* Understand that FreeSewing uses SVG
* Understand the coordinate system
* Learn that we use millimeter internally
* Learn about Bézier curves
***
icons:
- start
- pattern
about: |
A guide to go over a few things you should know when you start working with our core library
goals:
- Understand that FreeSewing provides parametric pattern design
- Understand that FreeSewing uses SVG
- Understand the coordinate system
- Learn that we use millimeter internally
- Learn about Bézier curves
---
Here's a few things that, once you get them, will make it easier to understand
what FreeSewing is doing, and how it's doing it.
what FreeSewing is doing, and how it's doing it.
We'll cover the following topics:
@ -31,11 +28,12 @@ We'll cover the following topics:
FreeSewing sits at the intersection of the world of makers and developers.
If your background is in development, you will need no explaining what SVG is, but might not
know much about designing sewing patterns.
know much about designing sewing patterns.
If on the other hand your background is in sewing or pattern design, you might wonder what
the heck Node JS is and why you should care.
Few people straddle both worlds, so as you start using FreeSewing, chances are
you'll learn a few new things along the way.
Few people straddle both worlds, so as you start using FreeSewing, chances are
you'll learn a few new things along the way.
</Note>

View file

@ -1,24 +1,23 @@
***
---
title: Parametric pattern design
order: 10
---------
---
The FreeSewing core library is a toolbox for **parametric pattern design**;
Using parameters or variables to manipulate the outcome of a given design.
In sewing patterns, the parameters are what is provided by the user:
In sewing patterns, the parameters are what is provided by the user:
Their measurements and options that they have selected.
<Note>
##### No more grading, ever
When drafting or designing patterns or garments, it is common practice to start
with a fit model (or dress form).
When drafting or designing patterns or garments, it is common practice to start
with a fit model (or dress form).
The measurements of the fit model are used as input in the initial design.
Adapting the pattern for a different model is a tedious task,
Adapting the pattern for a different model is a tedious task,
which is why patterns are graded up and down to cover different sizes.
But in a parametric sewing pattern, adapting to different sizes or models *just works*.
@ -27,8 +26,9 @@ But in a parametric sewing pattern, adapting to different sizes or models *just
FreeSewing patterns are implemented **as code**, which has a lot of advantages.
It allows for patterns that adapt to your measurements or preferences,
It allows for patterns that adapt to your measurements or preferences,
fine-grained version control, seamless collaboration, and using existing
patterns as a starting point for you own, to name but a few.
That being said, you don't have to be a code monkey to use FreeSewing.

View file

@ -1,16 +1,16 @@
***
---
title: SVG
order: 20
---------
---
Patterns are rendered as SVG — short
for [Scalable Vector Graphics](https://en.wikipedia.org/wiki/Scalable\_Vector\_Graphics) —
for [Scalable Vector Graphics](https://en.wikipedia.org/wiki/Scalable_Vector_Graphics) —
an XML-based vector image format and an open standard.
While you dont need to be an SVG expert, a basic understanding of the format
While you dont need to be an SVG expert, a basic understanding of the format
will greatly help you to understand FreeSewing.
For example, the coordinate system and the way paths
are structured are all related to the SVG drawing system, which is closely related
to other 2D drawing technologies such as PostScript or PDF.

View file

@ -1,13 +1,13 @@
***
---
title: Units
order: 40
---------
---
Internally, freesewing uses millimeter.
Internally, freesewing uses millimeter.
When you write `1`, thats one mm. When you write `7.8`, thats 7.8mm.
While you can use cm or inch on the FreeSewing website, that is merely a layer of
While you can use cm or inch on the FreeSewing website, that is merely a layer of
abstration on top of the internal units, which are always mm.
So as a pattern designer, you will work with mm.