chore(markdown): Cleanup of some pages
This commit is contained in:
Joost De Cock
parent
5177e42dd2
commit
6030252518
14 changed files with 24 additions and 128 deletions
|
|
@ -1,17 +1,6 @@
|
|||
---
|
||||
title: Markdown guide
|
||||
for: contributors
|
||||
order: 900
|
||||
icons:
|
||||
- edit
|
||||
- markdown
|
||||
about: |
|
||||
A quick primer on Markdown, the markup language you didn't know you needed in your life
|
||||
goals:
|
||||
- Understand what Markdown is
|
||||
- Format text with Markdown, including headers, paragraphs, links, and lists
|
||||
- Learn how to include images and tables
|
||||
- Learn about the different custom components
|
||||
---
|
||||
|
||||
Markdown is a lightweight markup language with plain text formatting syntax.
|
||||
|
|
|
|||
|
|
@ -1,13 +1,10 @@
|
|||
---
|
||||
title: Creating a new pattern design
|
||||
for: developers
|
||||
about: Shows you how to create a new design
|
||||
---
|
||||
|
||||
When creating a new design, you have two options:
|
||||
|
||||
- Create it in a stand-along development environment
|
||||
- Create it inside (your fork of ) the FreeSewing monorepo
|
||||
When creating a new design, you have two options. You can create it in a
|
||||
stand-along development environment. Or you can create it inside (your fork of)
|
||||
the FreeSewing monorepo.
|
||||
|
||||
If you are unsure what to pick, go with the standalong development environment.
|
||||
It is the best choice for people new to FreeSewing.
|
||||
|
|
|
|||
|
|
@ -1,12 +1,11 @@
|
|||
---
|
||||
title: Using macros
|
||||
for: developers
|
||||
about: Shows how you can use macros within your pattern
|
||||
---
|
||||
|
||||
Macros are a way to facilitate pattern design by bundling a bunch of individual actions
|
||||
into a little routine. Macros are provided by [plugins](/reference/plugins/).
|
||||
Macros are a way to facilitate pattern design by bundling a bunch of individual
|
||||
actions into a little routine. Macros are provided
|
||||
by [plugins](/reference/plugins/).
|
||||
|
||||
Refer to the [macros documentation](/reference/macros/) for details on how to use macros,
|
||||
and the [plugins](/reference/plugins/) documentation for info on how to create your
|
||||
own macros.
|
||||
Refer to the [macros documentation](/reference/macros/) for details on how to
|
||||
use macros, and the [plugins](/reference/plugins/) documentation for info on
|
||||
how to create your own macros.
|
||||
|
|
|
|||
|
|
@ -1,19 +0,0 @@
|
|||
---
|
||||
title: Remove paths from an inherited part
|
||||
for: developers
|
||||
about: When you inherit a part, it comes with a bunch of paths. Here'show to remove them
|
||||
---
|
||||
|
||||
<Note>
|
||||
|
||||
##### See this example in our source code
|
||||
|
||||
- [designs/carlton/src/back.js](https://github.com/freesewing/freesewing/blob/3ca5d0edfe54c7ac20aaf3af2f3544aee72f9b99/designs/carlton/src/back.js#L62)
|
||||
|
||||
</Note>
|
||||
|
||||
```js
|
||||
for (let i in paths) {
|
||||
if (['backArmhole', 'backCollar'].indexOf(i) === -1) delete paths[i]
|
||||
}
|
||||
```
|
||||
|
|
@ -1,20 +1,10 @@
|
|||
---
|
||||
title: Adapt the sleevecap length to fit the armhole
|
||||
for: developers
|
||||
about: Shows how to adapt the length of the sleevecap to fit your armhole
|
||||
---
|
||||
|
||||
<Note>
|
||||
|
||||
##### See this example in our source code
|
||||
|
||||
- [designs/bent/src/sleeve.js](https://github.com/freesewing/freesewing/blob/develop/designs/bent/src/sleeve.js)
|
||||
|
||||
</Note>
|
||||
|
||||
Fitting the sleevecap to the armhole means that we need to make sure the length
|
||||
of the seams match.
|
||||
A similar challenge is to fit the collar to the neck opening and so on.
|
||||
of the seams match. A similar challenge is to fit the collar to the neck
|
||||
opening and so on.
|
||||
|
||||
For all of these situations where you have to create curved seams with matching
|
||||
length, it's impossible to get it right from the first attempt.
|
||||
|
|
|
|||
|
|
@ -1,17 +1,7 @@
|
|||
---
|
||||
title: Add seam allowance and/or hem allowance
|
||||
for: developers
|
||||
about: Adding seam allowance or hem allowance is easy to do
|
||||
---
|
||||
|
||||
<Note>
|
||||
|
||||
##### See this example in our source code
|
||||
|
||||
- [designs/bruce/src/inset.js](https://github.com/freesewing/freesewing/blob/3ca5d0edfe54c7ac20aaf3af2f3544aee72f9b99/designs/bruce/src/inset.js#L32)
|
||||
|
||||
</Note>
|
||||
|
||||
Adding seam allowance is something that has to happen in every pattern.
|
||||
We might also have a hem where we need to add more seam allowance, or hem allowance.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,17 +1,7 @@
|
|||
---
|
||||
title: Slash and spread
|
||||
for: developers
|
||||
about: Slash and spread is easy enough on paper, here's how to do it in code
|
||||
---
|
||||
|
||||
<Note>
|
||||
|
||||
##### See this example in our source code
|
||||
|
||||
- [designs/jaeger/src/front.js](https://github.com/freesewing/freesewing/blob/3ca5d0edfe54c7ac20aaf3af2f3544aee72f9b99/designs/jaeger/src/front.js#L64)
|
||||
|
||||
</Note>
|
||||
|
||||
When we _slash and spread_ a pattern, we cut out a triangle, and then rotate it
|
||||
around the tip of the triangle.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,20 +1,9 @@
|
|||
---
|
||||
title: Add several of the same snippets with the sprinkle macro
|
||||
for: developers
|
||||
about: Adding multiple snippets doesn't need to be a chore with this handy macro
|
||||
---
|
||||
|
||||
<Note>
|
||||
|
||||
##### See this example in our source code
|
||||
|
||||
- [designs/jaeger/src/front.js](https://github.com/freesewing/freesewing/blob/3ca5d0edfe54c7ac20aaf3af2f3544aee72f9b99/designs/jaeger/src/front.js#L381)
|
||||
|
||||
</Note>
|
||||
|
||||
Adding multiple snippets at the same time results in a lot of repetitive code.
|
||||
|
||||
Better to use the `sprinkle` macro instead:
|
||||
It is better to use the `sprinkle` macro instead:
|
||||
|
||||
```js
|
||||
macro('sprinkle', {
|
||||
|
|
|
|||
|
|
@ -1,10 +1,12 @@
|
|||
---
|
||||
title: Adding a blog post
|
||||
for: editors
|
||||
---
|
||||
|
||||
Blog posts have been migrated to [Strapi](https://strapi.io/), a headless CMS system.
|
||||
Blog posts have been migrated to [Strapi](https://strapi.io/), a headless CMS
|
||||
system.
|
||||
|
||||
Our strapi instance can be accessed at [posts.freesewing.org](https://posts.freesewing.org/).
|
||||
Our strapi instance can be accessed at
|
||||
[posts.freesewing.org](https://posts.freesewing.org/).
|
||||
|
||||
If you don't have a Strapi account (yet), [reach out to us on Discord](https://discord.freesewing.org).
|
||||
If you don't have a Strapi account (yet), [reach out to us on
|
||||
Discord](https://discord.freesewing.org).
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
---
|
||||
title: Working with frontmatter
|
||||
for: editors
|
||||
---
|
||||
|
||||
Frontmatter is a way to add metadata to markdown documents.
|
||||
|
|
|
|||
|
|
@ -1,10 +1,12 @@
|
|||
---
|
||||
title: Adding a showcase on freesewing.org
|
||||
for: editors
|
||||
---
|
||||
|
||||
Showcase posts have been migrated to [Strapi](https://strapi.io/), a headless CMS system.
|
||||
Showcase posts have been migrated to [Strapi](https://strapi.io/), a headless
|
||||
CMS system.
|
||||
|
||||
Our strapi instance can be accessed at [posts.freesewing.org](https://posts.freesewing.org/).
|
||||
Our strapi instance can be accessed at
|
||||
[posts.freesewing.org](https://posts.freesewing.org/).
|
||||
|
||||
If you don't have a Strapi account (yet), [reach out to us on Discord](https://discord.freesewing.org).
|
||||
If you don't have a Strapi account (yet), [reach out to us on
|
||||
Discord](https://discord.freesewing.org).
|
||||
|
|
|
|||
|
|
@ -1,12 +1,5 @@
|
|||
---
|
||||
title: Where to get help
|
||||
for: contributors
|
||||
icons:
|
||||
- help
|
||||
- discord
|
||||
about: |
|
||||
Our [chatrooms on Discord](https://discord.freesewing.org/) are the best place to
|
||||
ask questions or share your feedback
|
||||
---
|
||||
|
||||
Our [chatrooms on Discord](https://discord.freesewing.org/) are the best place to
|
||||
|
|
|
|||
|
|
@ -1,18 +1,6 @@
|
|||
---
|
||||
title: Getting started on Linux
|
||||
order: 15
|
||||
for: developers
|
||||
icons:
|
||||
- start
|
||||
- linux
|
||||
about: |
|
||||
You'll learn how to setup Node JS on a Linux system,
|
||||
as well as initialize the FreeSewing development environment
|
||||
goals:
|
||||
- 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
|
||||
|
|
|
|||
|
|
@ -1,19 +1,6 @@
|
|||
---
|
||||
title: Getting started on Mac
|
||||
order: 25
|
||||
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
|
||||
---
|
||||
|
||||
In this tutorial, we will setup Node JS and initialize the FreeSewing
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue