chore: Remark linter run
This commit is contained in:
parent
b6dab9f8fa
commit
e6f1189017
164 changed files with 395 additions and 395 deletions
|
@ -13,13 +13,13 @@ that you should take into account while developing your pattern. They are:
|
|||
## Complete
|
||||
|
||||
The [complete](/reference/api/settings#complete) setting is a boolean that is either true or false.
|
||||
Its goal is to determine whether we should draft a *complete* pattern, or merely the outline.
|
||||
Its goal is to determine whether we should draft a _complete_ pattern, or merely the outline.
|
||||
|
||||
## Paperless
|
||||
|
||||
The [paperless](/reference/api/settings#paperless) setting is a boolean that is either true or false.
|
||||
|
||||
A *paperless* pattern is a pattern that has extra dimensions so users can trace the
|
||||
A _paperless_ pattern is a pattern that has extra dimensions so users can trace the
|
||||
paper on fabric or paper without having the need to print it.
|
||||
|
||||
## Seam allowance
|
||||
|
|
|
@ -17,7 +17,7 @@ Instead, embrace percentages as options.
|
|||
##### Use the antperson tests
|
||||
|
||||
To check how well your pattern scales, you can
|
||||
use the *antperson* test by sampling the pattern for 2 models:
|
||||
use the _antperson_ test by sampling the pattern for 2 models:
|
||||
|
||||
- A model with measurements of avarage person (the person)
|
||||
- A model with measurements 1/10th of an average person (the ant)
|
||||
|
|
|
@ -5,7 +5,7 @@ order: 60
|
|||
|
||||
Don't insert literal text in your patterns. Instead, insert a key that can then be translated.
|
||||
|
||||
For example, if you want to put *Finish with bias tape* on your pattern, don't be
|
||||
For example, if you want to put _Finish with bias tape_ on your pattern, don't be
|
||||
tempted to do this:
|
||||
|
||||
```js
|
||||
|
|
|
@ -13,7 +13,7 @@ You can find a list of all FreeSewing guides below:
|
|||
|
||||
Guides tell a story to further your understanding of a specific topic.
|
||||
|
||||
Guides and howtos are on a spectrum with howtos being terse *do-this-then-that* recipes, whereas
|
||||
Guides and howtos are on a spectrum with howtos being terse _do-this-then-that_ recipes, whereas
|
||||
guides take more time to explain in-depth what is being done and why.
|
||||
|
||||
For more details, refer to [How we structure our documentation](/guides/docs).
|
||||
|
|
|
@ -4,7 +4,7 @@ order: 90
|
|||
---
|
||||
|
||||
The way we render markdown on our websites is through the use of [MDX](https://mdxjs.com/).\
|
||||
This allows us to extend Markdown with our own so-called *custom components*.
|
||||
This allows us to extend Markdown with our own so-called _custom components_.
|
||||
|
||||
Such custom components allow us to put things in Markdown content that would
|
||||
typically require a lot more complexity.
|
||||
|
|
|
@ -7,7 +7,7 @@ Some things to keep in mind when working in Markdown are:
|
|||
|
||||
## Use remark-jargon for glossary terms
|
||||
|
||||
There is no need to add a *glossary* section to documentation.
|
||||
There is no need to add a _glossary_ section to documentation.
|
||||
We use a plugin called [remark-jargon][rj] to explain terms.
|
||||
Information can be found at the link.
|
||||
|
||||
|
|
|
@ -8,10 +8,10 @@ You can make text *italic* or **bold**
|
|||
by wrapping it in 1 or 2 asterisk respectively.
|
||||
```
|
||||
|
||||
You can make text *italic* or **bold** by wrapping it in 1 or 2 asterisk respectively:
|
||||
You can make text _italic_ or **bold** by wrapping it in 1 or 2 asterisk respectively:
|
||||
|
||||
```md
|
||||
Alternatively, you can also use underscores to mark _italic_ or __bold__.
|
||||
```
|
||||
|
||||
Alternatively, you can also use underscores to mark *italic* or **bold**.
|
||||
Alternatively, you can also use underscores to mark _italic_ or **bold**.
|
||||
|
|
|
@ -19,7 +19,7 @@ If we look at our image, it can be 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 right area with the **draft** box and the _SVG_ and _React_ logos
|
||||
|
||||
Let's take a closer look at everything that is contained within our central **Pattern** box:
|
||||
|
||||
|
@ -27,7 +27,7 @@ Let's take a closer look at everything that is contained within our central **Pa
|
|||
|
||||
<Note>
|
||||
|
||||
The left and right parts are all about how to integrate FreeSewing in your *frontend*.
|
||||
The left and right parts are all about how to integrate FreeSewing in your _frontend_.
|
||||
In other words, how you'll plug it into your website, or online store, or a mobile
|
||||
application.
|
||||
|
||||
|
|
|
@ -11,7 +11,7 @@ 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
|
||||
and the store.
|
||||
|
||||
In reality, your pattern will be a *constructor* that takes the user's settings as
|
||||
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
|
||||
|
|
|
@ -52,9 +52,9 @@ const Pattern = new freesewing.Design(
|
|||
Our condition method will return `true` only if the following conditions are met:
|
||||
|
||||
- A `settings` object is passed into the method
|
||||
- `settings.options` is *truthy*
|
||||
- `settings.options.draftForHighBust` is *truthy*
|
||||
- `settings.options.measurements.highBust` is *truthy*
|
||||
- `settings.options` is _truthy_
|
||||
- `settings.options.draftForHighBust` is _truthy_
|
||||
- `settings.options.measurements.highBust` is _truthy_
|
||||
|
||||
This is a real-world example from our Teagan pattern. A t-shirt pattern that can be
|
||||
drafted to the high bust (rather than the full chest circumference) if the user
|
||||
|
|
|
@ -30,7 +30,7 @@ Our [plugin bundle](/reference/plugins/bundle/) bundles build-time plugins that
|
|||
A plugin is a run-time plugin if it can be added after instantiating your pattern.
|
||||
Think of it as a plugin to be used in the front-end.
|
||||
|
||||
Run-time plugins are not a dependecy of the pattern. They just *add something* to it.
|
||||
Run-time plugins are not a dependecy of the pattern. They just _add something_ to it.
|
||||
|
||||
Our [theme plugin](/reference/plugins/theme/) is a good example of a run-time plugin.
|
||||
If it's missing, your pattern will still work, it just won't look pretty.
|
||||
|
|
|
@ -21,13 +21,13 @@ In FreeSewing, we use so-called cubic Bézier curves which have:
|
|||
An example of a Bézier curve drawn by the Path.curve() method
|
||||
</Example>
|
||||
|
||||
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:
|
||||
|
||||

|
||||
|
||||
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.
|
||||
As long as you intuitively _get_ how the control points influence the curve, you're good to go.
|
||||
|
||||
<Note>
|
||||
|
||||
|
|
|
@ -79,7 +79,7 @@ expect to find the same structure, the same amount of headings, paragraphs and s
|
|||
|
||||
### Strapi
|
||||
|
||||
Strapi ([strapi.io](https://strapi.io/)) is a so-called *headless content management system (CMS)*.
|
||||
Strapi ([strapi.io](https://strapi.io/)) is a so-called _headless content management system (CMS)_.
|
||||
Headless just means that we load the content from it via an API, rather than have it be part of our
|
||||
website like a classic CMS (eg. Wordpress).
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue