chore(markdown): Docs linter run
This commit is contained in:
joostdecock
parent
39fbdd477f
commit
9f958656d9
2383 changed files with 32481 additions and 7187 deletions
|
|
@ -3,7 +3,7 @@ title: Getting started with GitPod
|
|||
order: 10
|
||||
---
|
||||
|
||||
If you don't want to set up a dev environment, or just want to kick the
|
||||
If you don't want to set up a dev environment, or just want to kick the
|
||||
tires like, right now, you can run our development environment in your browser via Gitpod:
|
||||
|
||||
https://gitpod.io/#https://github.com/freesewing/freesewing
|
||||
|
|
@ -12,7 +12,4 @@ https://gitpod.io/#https://github.com/freesewing/freesewing
|
|||
We recommend that you fork our repository so you can push changes to the repository.
|
||||
To do so, simple adapt the URL above as follows:
|
||||
|
||||
https://gitpod.io/#url-to-your-fork
|
||||
</Tip>
|
||||
|
||||
|
||||
https://gitpod.io/#url-to-your-fork </Tip>
|
||||
|
|
|
|||
|
|
@ -41,7 +41,8 @@ But if you're running Linux, you have git, right?
|
|||
</Comment>
|
||||
|
||||
#### Install yarn
|
||||
Our repository uses yarn workspaces. So you'll need yarn to work with it.
|
||||
|
||||
Our repository uses yarn workspaces. So you'll need yarn to work with it.
|
||||
|
||||
To install it run:
|
||||
|
||||
|
|
@ -95,6 +96,7 @@ Now you're ready to [start the development environment](/tutorials/getting-start
|
|||
### Questions
|
||||
|
||||
#### What template to use
|
||||
|
||||
Use `From scratch` unless you want to start from our of our blocks:
|
||||
|
||||
- Use `Extend Brian` to start from [Brian](https://freesewing.org/designs/brian)
|
||||
|
|
@ -103,10 +105,9 @@ Use `From scratch` unless you want to start from our of our blocks:
|
|||
- Use `Extend Breanna` to start from [Breanna](https://freesewing.org/designs/breanna)
|
||||
- Use `Extend Titan` to start from [Titan](https://freesewing.org/designs/titan)
|
||||
|
||||
|
||||
#### What name to use
|
||||
|
||||
This will become the name of your design. Stick to \[a-z\] here to avoid problems.
|
||||
This will become the name of your design. Stick to \[a-z] here to avoid problems.
|
||||
|
||||
If you're not certain what to pick, just mash some keys, it doesn't matter.
|
||||
|
||||
|
|
@ -115,5 +116,3 @@ If you're not certain what to pick, just mash some keys, it doesn't matter.
|
|||
Chose `npm` if you don't have `yarn` are when you're not sure what the heck `yarn` is.
|
||||
|
||||
</Note>
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -28,8 +28,7 @@ This is all you need to work on existing designs. If you'd like to add a new des
|
|||
yarn new design
|
||||
```
|
||||
|
||||
Just make sure to re-start the lab afterwards with `yarn lab`
|
||||
</Tip>
|
||||
Just make sure to re-start the lab afterwards with `yarn lab` </Tip>
|
||||
|
||||
## Standalone development
|
||||
|
||||
|
|
@ -39,7 +38,7 @@ If you chose `test`, you will have a `test` folder. If you chose `banana`, you'l
|
|||
The `design` subfolder holds your design's configuration file and source code.
|
||||
You can ignore all other folders and files, they are part of the development environment.
|
||||
|
||||
To start the development environment, enter the folder hat was created
|
||||
To start the development environment, enter the folder hat was created
|
||||
and run `npm run start` (or `yarn start` if you're using Yarn as a package manager).
|
||||
|
||||
Then open your browser and go to http://localhost:8000
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ the node.js website, or from a package provided by your linux distribution:
|
|||
- You can easily switch between different Node versions
|
||||
- Everything gets installed in your home folder, avoiding permission problems
|
||||
|
||||
To setup nvm, [follow the install instructions in the nvm
|
||||
To setup nvm, [follow the install instructions in the nvm
|
||||
README](https://github.com/nvm-sh/nvm#installing-and-updating).
|
||||
|
||||
The TL;DR: is to run the following command in a terminal:
|
||||
|
|
|
|||
|
|
@ -56,4 +56,3 @@ and even suggest the command you should type to install it. Handy!
|
|||
<Note compact>
|
||||
Node 14 is required to use our monorepo [until we upgrade Strapi](https://github.com/freesewing/freesewing/issues/2351).
|
||||
</Note>
|
||||
|
||||
|
|
|
|||
|
|
@ -41,7 +41,8 @@ But if you're running macOS, you have git, right?
|
|||
</Comment>
|
||||
|
||||
#### Install yarn
|
||||
Our repository uses yarn workspaces. So you'll need yarn to work with it.
|
||||
|
||||
Our repository uses yarn workspaces. So you'll need yarn to work with it.
|
||||
|
||||
To install it run:
|
||||
|
||||
|
|
@ -95,6 +96,7 @@ Now you're ready to [start the development environment](/tutorials/getting-start
|
|||
### Questions
|
||||
|
||||
#### What template to use
|
||||
|
||||
Use `From scratch` unless you want to start from our of our blocks:
|
||||
|
||||
- Use `Extend Brian` to start from [Brian](https://freesewing.org/designs/brian)
|
||||
|
|
@ -103,9 +105,9 @@ Use `From scratch` unless you want to start from our of our blocks:
|
|||
- Use `Extend Breanna` to start from [Breanna](https://freesewing.org/designs/breanna)
|
||||
- Use `Extend Titan` to start from [Titan](https://freesewing.org/designs/titan)
|
||||
|
||||
|
||||
#### What name to use
|
||||
This will become the name of your design. Stick to \[a-z\] here to avoid problems.
|
||||
|
||||
This will become the name of your design. Stick to \[a-z] here to avoid problems.
|
||||
|
||||
If you're not certain what to pick, just mash some keys, it doesn't matter.
|
||||
|
||||
|
|
@ -114,5 +116,3 @@ If you're not certain what to pick, just mash some keys, it doesn't matter.
|
|||
Chose `npm` if you don't have `yarn` are when you're not sure what the heck `yarn` is.
|
||||
|
||||
</Note>
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -28,8 +28,7 @@ This is all you need to work on existing designs. If you'd like to add a new des
|
|||
yarn new design
|
||||
```
|
||||
|
||||
Just make sure to re-start the lab afterwards with `yarn lab`
|
||||
</Tip>
|
||||
Just make sure to re-start the lab afterwards with `yarn lab` </Tip>
|
||||
|
||||
## Standalone development
|
||||
|
||||
|
|
@ -39,7 +38,7 @@ If you chose `test`, you will have a `test` folder. If you chose `banana`, you'l
|
|||
The `design` subfolder holds your design's configuration file and source code.
|
||||
You can ignore all other folders and files, they are part of the development environment.
|
||||
|
||||
To start the development environment, enter the folder hat was created
|
||||
To start the development environment, enter the folder hat was created
|
||||
and run `npm run start` (or `yarn start` if you're using Yarn as a package manager).
|
||||
|
||||
Then open your browser and go to http://localhost:8000
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ the node.js website, or from a package provided by your linux distribution:
|
|||
- You can easily switch between different Node versions
|
||||
- Everything gets installed in your home folder, avoiding permission problems
|
||||
|
||||
To setup nvm, [follow the install instructions in the nvm
|
||||
To setup nvm, [follow the install instructions in the nvm
|
||||
README](https://github.com/nvm-sh/nvm#installing-and-updating).
|
||||
|
||||
The TL;DR: is to run the following command in a terminal:
|
||||
|
|
|
|||
|
|
@ -45,9 +45,8 @@ Click on any of the options we've added to our pattern, and your bib will be dra
|
|||
|
||||
The `lengthRatio` option controls the length of our bib. Testing it confirms that it only influences the length:
|
||||
|
||||
<Example sample part="bib" pattern="tutorial" settings={{ sample: { type: "option", option: "lengthRatio" } }}>
|
||||
Your bib with the lengthRatio option sampled
|
||||
</Example>
|
||||
\<Example sample part="bib" pattern="tutorial" settings={{ sample: { type: "option", option: "lengthRatio" } }}>
|
||||
Your bib with the lengthRatio option sampled </Example>
|
||||
|
||||
### neckRatio
|
||||
|
||||
|
|
@ -58,9 +57,8 @@ neck opening.
|
|||
Testing it confirms this. We can also see that as the neck opening gets smaller, we will rotate the straps
|
||||
further out of the way to avoid overlap:
|
||||
|
||||
<Example sample part="bib" pattern="tutorial" settings={{ sample: { type: "option", option: "neckRatio" } }} >
|
||||
Your bib with the neckRatio option sampled
|
||||
</Example>
|
||||
\<Example sample part="bib" pattern="tutorial" settings={{ sample: { type: "option", option: "neckRatio" } }} >
|
||||
Your bib with the neckRatio option sampled </Example>
|
||||
|
||||
### widthRatio
|
||||
|
||||
|
|
@ -81,9 +79,8 @@ covered in this tutorial. It is left _as an exercise to the reader_.
|
|||
|
||||
</Note>
|
||||
|
||||
<Example sample part="bib" pattern="tutorial" settings={{ sample: { type: "option", option: "widthRatio" } }}>
|
||||
Your bib with the widthRatio option sampled
|
||||
</Example>
|
||||
\<Example sample part="bib" pattern="tutorial" settings={{ sample: { type: "option", option: "widthRatio" } }}>
|
||||
Your bib with the widthRatio option sampled </Example>
|
||||
|
||||
## Testing measurements
|
||||
|
||||
|
|
@ -92,9 +89,8 @@ This gives you the option to determine how any given measurement is influencing
|
|||
|
||||
For our bib, we only use one measurement, so it influences the entire pattern:
|
||||
|
||||
<Example sample part="bib" pattern="tutorial" settings={{ sample: { type: "measurement", measurement: "head" } }}>
|
||||
Your bib with the head circumference measurement sampled
|
||||
</Example>
|
||||
\<Example sample part="bib" pattern="tutorial" settings={{ sample: { type: "measurement", measurement: "head" } }}>
|
||||
Your bib with the head circumference measurement sampled </Example>
|
||||
|
||||
## Testing models
|
||||
|
||||
|
|
@ -108,9 +104,8 @@ set of measurements.
|
|||
But most patterns use multiple measurements, and you'll find this test gives you insight into how your
|
||||
pattern will adapt to differently sized bodies.
|
||||
|
||||
<Example sample pattern="tutorial" part="bib" settings={{ sample: { type: "models", models: { baby1: { head: 340 }, baby2: { head: 350 }, baby3: { head: 360 }, baby4: { head: 370 }, baby5: { head: 380 }, baby6: { head: 390 }, baby7: { head: 400 }, baby8: { head: 410 }, baby9: { head: 420 } } } }}>
|
||||
Your bib sampled for a range of baby sizes
|
||||
</Example>
|
||||
\<Example sample pattern="tutorial" part="bib" settings={{ sample: { type: "models", models: { baby1: { head: 340 }, baby2: { head: 350 }, baby3: { head: 360 }, baby4: { head: 370 }, baby5: { head: 380 }, baby6: { head: 390 }, baby7: { head: 400 }, baby8: { head: 410 }, baby9: { head: 420 } } } }}>
|
||||
Your bib sampled for a range of baby sizes </Example>
|
||||
|
||||
## The antperson test
|
||||
|
||||
|
|
@ -128,8 +123,7 @@ don't scale, and you should avoid them.
|
|||
|
||||
The best patterns will pass the antperson test with 2 patterns exactly the same, where one will simply be 1/10th the scale of the other.
|
||||
|
||||
<Example sample pattern="tutorial" part="bib" settings={{ sample: { type: "models", models: { ant: { head: 39 }, man: { head: 390 }, } } }}>
|
||||
Congratulations, your bib passes the antperson test
|
||||
</Example>
|
||||
\<Example sample pattern="tutorial" part="bib" settings={{ sample: { type: "models", models: { ant: { head: 39 }, man: { head: 390 }, } } }}>
|
||||
Congratulations, your bib passes the antperson test </Example>
|
||||
|
||||
When you're happy with how your pattern passes these tests, it's time to complete it.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue