chore: Linting for markdown and js
This commit is contained in:
joostdecock
parent
eca8199ed8
commit
1c92e0f655
6677 changed files with 24391 additions and 25987 deletions
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Setting up the FreeSewing development environment
|
||||
order: 50
|
||||
---
|
||||
---------
|
||||
|
||||
FreeSewing provides a development environment to help you design and develop patterns.
|
||||
|
||||
|
|
@ -17,19 +18,17 @@ You can change all of these later. It's just to get you started.
|
|||
If you're not sure what to fill in, you can stick with the defaults or leave them blank.
|
||||
Only a few of these are mandatory.
|
||||
|
||||
- **Language**: Use the arrow keys to chose the language of your choice
|
||||
- **Pattern name**: This will be the name of your pattern, but also the name of the folder we'll setup for you. If you're just kicking the tires, something like `test` will do you fine.
|
||||
- **description**: A description of your pattern. It's not mandatory.
|
||||
- **Pattern type**: Use the arrow keys to chose either `block` or `pattern`. Choose `pattern` if you're not sure what to pick
|
||||
- **department**: Use the arrow keys to pick a department like `tops`, `bottoms` or `accessories`. This is is only relevant if you decide to publish your pattern later. But by that time you will have learned how to change this.
|
||||
- **Author**: You can enter your name, or leave this blank for now
|
||||
- **GitHub repository**: You can leave this blank for now
|
||||
- **Package manager**: Choose either `npm` or `yarn` as your package manager. If you're not sure, pick `npm`.
|
||||
|
||||
* **Language**: Use the arrow keys to chose the language of your choice
|
||||
* **Pattern name**: This will be the name of your pattern, but also the name of the folder we'll setup for you. If you're just kicking the tires, something like `test` will do you fine.
|
||||
* **description**: A description of your pattern. It's not mandatory.
|
||||
* **Pattern type**: Use the arrow keys to chose either `block` or `pattern`. Choose `pattern` if you're not sure what to pick
|
||||
* **department**: Use the arrow keys to pick a department like `tops`, `bottoms` or `accessories`. This is is only relevant if you decide to publish your pattern later. But by that time you will have learned how to change this.
|
||||
* **Author**: You can enter your name, or leave this blank for now
|
||||
* **GitHub repository**: You can leave this blank for now
|
||||
* **Package manager**: Choose either `npm` or `yarn` as your package manager. If you're not sure, pick `npm`.
|
||||
|
||||
When you've answered all questions, the command will download the development enviroment,
|
||||
and set it up based on the choices you made.
|
||||
|
||||
This step will take anywhere from a few to about 10 minutes to complete.
|
||||
But when it's done, you will have a new folder with the development environent inside.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,22 +1,25 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Getting started on Mac
|
||||
order: 20
|
||||
for: developers
|
||||
icons:
|
||||
- start
|
||||
- apple
|
||||
about: |
|
||||
You'll learn how to setup Node JS on a Mac system,
|
||||
as well as initialize the FreeSewing development environment.
|
||||
goals:
|
||||
- Install Xcode command-line tools
|
||||
- Install Node JS using nvm
|
||||
- Chosing a Node version to use
|
||||
- Initializing the FreeSewing development environment
|
||||
- Starting the FreeSewing development environment
|
||||
---
|
||||
icons:
|
||||
|
||||
In this tutorial, we will setup Node JS and initialize the FreeSewing
|
||||
* start
|
||||
* apple
|
||||
about: |
|
||||
You'll learn how to setup Node JS on a Mac system,
|
||||
as well as initialize the FreeSewing development environment.
|
||||
goals:
|
||||
* Install Xcode command-line tools
|
||||
* Install Node JS using nvm
|
||||
* Chosing a Node version to use
|
||||
* Initializing the FreeSewing development environment
|
||||
* Starting the FreeSewing development environment
|
||||
|
||||
***
|
||||
|
||||
In this tutorial, we will setup Node JS and initialize the FreeSewing
|
||||
development environment on a Mac system running OS X.
|
||||
|
||||
<Tip>
|
||||
|
|
@ -29,4 +32,3 @@ application at `/Applications/Utilities/`.
|
|||
We'll cover the following steps:
|
||||
|
||||
<ReadMore list />
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Installing Node
|
||||
order: 30
|
||||
---
|
||||
---------
|
||||
|
||||
Now we will use nvm to install Node JS. Run the following command:
|
||||
|
||||
|
|
@ -12,4 +13,3 @@ nvm install lts/*
|
|||
This will install the most recent so-called LTS version on your system.
|
||||
LTS versions -- short for Long Term Support -- are good node versions
|
||||
to use because they are stable and supported for a long time.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,18 +1,19 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Installing nvm
|
||||
order: 20
|
||||
---
|
||||
---------
|
||||
|
||||
FreeSewing is built with [Node.js](https://nodejs.org/), a JavaScript runtime.
|
||||
|
||||
You'll need to install Node JS on your system, and to do so, we'll
|
||||
use [nvm](https://github.com/nvm-sh/nvm), short for _Node version manager_.
|
||||
You'll need to install Node JS on your system, and to do so, we'll
|
||||
use [nvm](https://github.com/nvm-sh/nvm), short for *Node version manager*.
|
||||
|
||||
Using nvm has a number few benefits in comparison with installing Node from
|
||||
the node.js website, or from a package providide by your linux distribution:
|
||||
|
||||
- You can easily switch between different Node versions
|
||||
- Everything gets installed in your home folder, avoiding permission problems
|
||||
* You can easily switch between different Node versions
|
||||
* Everything gets installed in your home folder, avoiding permission problems
|
||||
|
||||
To setup nvm, run the following command in a terminal window:
|
||||
|
||||
|
|
@ -32,7 +33,7 @@ After the script is completed, try running the following command:
|
|||
nvm
|
||||
```
|
||||
|
||||
If all goes well, it should show you the nvm help.
|
||||
If all goes well, it should show you the nvm help.
|
||||
|
||||
<Tip>
|
||||
|
||||
|
|
@ -40,4 +41,3 @@ If you get `nvm: command not found` or something similar, close the Terminal
|
|||
application, and open a new one. Now `nvm` should be found.
|
||||
|
||||
</Tip>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,11 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Installing the Xcode command line tools
|
||||
order: 10
|
||||
---
|
||||
---------
|
||||
|
||||
Before we can get started, we need some basic tools for development.
|
||||
They are bundled in the _Xcode command-line tools_ so let's install
|
||||
They are bundled in the *Xcode command-line tools* so let's install
|
||||
that first.
|
||||
|
||||
Open the Terminal application, and type the following command:
|
||||
|
|
@ -15,4 +16,3 @@ xcode-select --install
|
|||
|
||||
A popup will appear asking you to confirm the installation.
|
||||
Confirm, and go make a cup of coffee while the install does its thing.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Using a different Node version
|
||||
order: 40
|
||||
---
|
||||
---------
|
||||
|
||||
Now that you've got Node setup, we can start setting up the FreeSewing
|
||||
development environment.
|
||||
|
|
@ -17,8 +18,8 @@ To see the different Node versions on your system, run this command:
|
|||
nvm ls
|
||||
```
|
||||
|
||||
It will show you a list of local node versions.
|
||||
Either the version number, or an _alias_ that points to a specific version.
|
||||
It will show you a list of local node versions.
|
||||
Either the version number, or an *alias* that points to a specific version.
|
||||
You should see the `lts/*` alias in the list which is what we've just installed.
|
||||
|
||||
### nvm ls-remote
|
||||
|
|
@ -52,4 +53,3 @@ nvm use v10.22.1
|
|||
|
||||
If you picked a version that is not installed, `nvm` will simply tell you
|
||||
and even suggest the command you should type to install it. Handy!
|
||||
|
||||
|
|
|
|||
|
|
@ -1,16 +1,17 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Start the development environment
|
||||
order: 60
|
||||
---
|
||||
---------
|
||||
|
||||
You will have a new folder that has the name you picked for your pattern.
|
||||
If you chose `test`, you will have a `test` folder. If you chose `banana`, you'll have a `banana` folder.
|
||||
|
||||
If you enter that folder, you'll find a couple of subfolders:
|
||||
|
||||
- `config` holds your pattern's configuration file
|
||||
- `src` holds your pattern's source code
|
||||
- `example` holds the development environment
|
||||
* `config` holds your pattern's configuration file
|
||||
* `src` holds your pattern's source code
|
||||
* `example` holds the development environment
|
||||
|
||||
To start the development environment, enter the `example` folder and run: `npm run start` (or `yarn start` if you're using Yarn as a package manager.
|
||||
|
||||
|
|
@ -24,7 +25,6 @@ the pattern's source code. When you do, it will update automatically in your bro
|
|||
All you have to do now, is design your pattern.
|
||||
Thankfully, we have a tutorial for that too:
|
||||
|
||||
- [Pattern design tutorial](/tutorials/pattern-design/): A step-by-step guide to designing your first pattern
|
||||
* [Pattern design tutorial](/tutorials/pattern-design/): A step-by-step guide to designing your first pattern
|
||||
|
||||
</Note>
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue