1
0
Fork 0

feat: Flat import of markdown repo

This is a flat (without history) import of (some of) the content
from our markdown module.

We've imported this without history because the repo contains our
blog posts and showcases posts content prior to porting them to strapi.

Since this contains many images, it would balloon the size of this repo
to import the full history.

Instead, please refer to the history of the (archived) markdown repo
at: https://github.com/freesewing/markdown
This commit is contained in:
Joost De Cock 2021-08-25 16:09:31 +02:00
parent 1671a896b5
commit b34a2ee2ed
6132 changed files with 244167 additions and 0 deletions

View file

@ -0,0 +1,13 @@
---
title: Add the body of the blog post
order: 90
---
Below the frontmatter, you can write the body of your blog post, [using markdown](/editors/markdown/).
<Tip>
You can look at [one of the many blog posts](https://github.com/freesewing/markdown/tree/develop/org/blog) for examples.
</Tip>

View file

@ -0,0 +1,34 @@
---
title: Add the frontmatter
order: 40
---
Frontmatter is metadata that we add to the top of the file.
Please refere to [working with frontmatter](/howtos/editors/frontmatter/) if you're not sure how to use it.
The following fields need to be filled in:
| Name | Description |
| ----:| ----------- |
| `date` | **Must** be in format `YYYY-MM-DD` |
| `title` | Title of the blog post |
| `linktitle` | If the title is very long, you can specify an alternative title for use in menus, breadcrumbs, and so on. This field is optional. |
| `img` | Filename of the main image. Must be placed in the folder of the showcase |
| `caption` | The caption that will go below the image |
| `author` | FreeSewing username of the author |
Below is an example:
```md
---
date: 2020-09-09
title: FreeSewing 2.9 brings our Teagan T-shirt pattern
linktitle: "Our latest pattern is Teagan, a fitted T-shirt"
img: teagan2.jpg
caption: "Photo by Alex Andrews from Pexels"
author: joost
---
```
Add the frontmatter to the top of the `en.md` file.

View file

@ -0,0 +1,23 @@
---
title: Add images to the folder
order: 30
---
Add the images you want to use to the folder. Keep the following guidelines in mind:
- The main blog picture should be a landscape image
- The best resolution for the main image is 2000x1348 pixels
- None of the images should be larger than 2000px on their longest side
- Use lowercase for all filenames
<Note>
##### Please think twice before dropping a 7Mb image.
Git never forgets. So if you drop a couple of 7Mb images into our repo,
they will be there forever, making cloning the repo very slow.
So please resize your images before you commit your changes.
</Note>

View file

@ -0,0 +1,14 @@
---
title: Create a new file for the blog post
order: 20
---
In the folder you just created, create a new empty file, and name it `en.md`.
<Note>
While we support translation, we do not support adding original content in
any language other than English. This is why the file **must** be named
`en.md` and be written in English.
</Note>

View file

@ -0,0 +1,18 @@
---
title: Create a new folder for the blog post
order: 10
---
Our [markdown repository](https://github.com/freesewing/markdown/) holds all content
for both freesewing.org and freesewing.dev.
The content for blog posts on freesewing.org is in the `org/blog` folder.
You'll find a bunch of directories here for all the existing blog posts.
Create a new one keeping in mind that this will determine the URL under which the post
is available. So:
- No spaces
- No uppercase
- Stick to `a-z` and `-` to be safe

View file

@ -0,0 +1,15 @@
---
title: Adding a blog post on freesewing.org
for: editors
---
These are the steps required to add a new [blog post](https://freesewing.org/showcase/) to the website:
<ReadMore list />
- Create a new folder in the `org/blog` directory of [our markdown repository](https://github.com/freesewing/markdown/)
- Add an `en.md` markdown file to this folder
- Add one of more images to the folder
- Add the frontmatter to the file
- Add the body of the file

View file

@ -0,0 +1,7 @@
---
title: Common tasks for editors
---
Below is a list of commons tasks for editors
<ReadMore list />

View file

@ -0,0 +1,17 @@
---
title: About frontmatter
order: 10
---
Frontmatter is a way to add metadata to markdown documents.
Frontmatter sits at the top of the file (it's matter that's at the front) and is
surrounded by lines with three dashes on them:
```md
---
title: This is frontmatter
---
```
<ReadMore list />

View file

@ -0,0 +1,11 @@
---
title: Working with frontmatter
for: editors
---
Frontmatter is a way to add metadata to markdown documents.
It is used extensively on freesewing.org and freesewing.dev alike.
Here's what you need to know:
<ReadMore list />

View file

@ -0,0 +1,16 @@
---
title: Lists or arrays
order: 30
---
Values are typically text or numbers, but you can also make it a list or array.
There's two types of syntax for this:
```md
tags: [tag1, another, three]
categories:
- cat1
- anothercat
- somethingelse
```

View file

@ -0,0 +1,16 @@
---
title: Mult-line text
order: 40
---
To add multi-line text in frontmatter, use a `|` character,
and prefix the lines by spaces:
```md
about: |
This is a multi-line text
that will be assigned to the about key
```

View file

@ -0,0 +1,12 @@
---
title: Structure
order: 20
---
Frontmatter is made up of `key: value` pairs.
The value must be quoted if you use a `:` in it to avoid problems parsing the key values:
```md
title: This does not need to be quoted
slogan: "Markdown: This is the way"
```

View file

@ -0,0 +1,12 @@
---
title: Add the body of the showcase post
order: 50
---
Below the frontmatter, you can write the body of your showcase post, [using markdown](/editors/markdown/).
<Tip>
You can look at [one of the many showcases](https://github.com/freesewing/markdown/tree/develop/org/showcase) for examples.
</Tip>

View file

@ -0,0 +1,33 @@
---
title: Add the frontmatter
order: 40
---
Frontmatter is metadata that we add to the top of the file.
Please refere to [working with frontmatter](/howtos/editors/frontmatter/) is you're not sure how to use it.
The following fields need to be filled in:
| Name | Description |
| ----:| ----------- |
| `date` | **Must** be in format `YYYY-MM-DD` |
| `title` | Title of the showcase |
| `img` | Filename of the main image. Must be placed in the folder of the showcase |
| `caption` | The caption that will go below the image |
| `patterns` | An array of designs/patterns that are being showcased. Lowercase only |
| `author` | FreeSewing username of the author |
Below is an example:
```md
---
date: 2018-09-29
title: Yoga Outfit by Paul
img: showcase.jpg
caption: "Aaron and Bruce yoga set with stripes by Paul (up-side-down)"
patterns: [aaron,bruce]
author: Tiger751023
---
```
Add the frontmatter to the top of the `en.md` file.

View file

@ -0,0 +1,23 @@
---
title: Add images to the folder
order: 30
---
Add the images you want to use to the folder. Keep the following guidelines in mind:
- The main showcase picture should, if possible, be a landscape image
- The best resolution for the main image is 2000x1348 pixels
- None of the images should be larger than 2000px on their longest side
- Use lowercase for all filenames
<Note>
##### Please think twice before dropping a 7Mb image.
Git never forgets. So if you drop a couple of 7Mb images into our repo,
they will be there forever, making cloning the repo very slow.
So please resize your images before you commit your changes.
</Note>

View file

@ -0,0 +1,14 @@
---
title: Create a new file for the showcase post
order: 20
---
In the folder you just created, create a new empty file, and name it `en.md`.
<Note>
While we support translation, we do not support adding original content in
any language other than English. This is why the file **must** be named
`en.md` and be written in English.
</Note>

View file

@ -0,0 +1,18 @@
---
title: Create a new folder for the showcase post
order: 10
---
Our [markdown repository](https://github.com/freesewing/markdown/) holds all content
for both freesewing.org and freesewing.dev.
The content for showcases on freesewing.org is in the `org/showcase` folder.
You'll find a bunch of directories here for all the existing showcases.
Create a new one keeping in mind that this will determine the URL under which the showcase
is available. So:
- No spaces
- No uppercase
- Stick to `a-z` and `-` to be safe

View file

@ -0,0 +1,82 @@
---
title: Adding a showcase on freesewing.org
for: editors
---
These are the steps required to add a new [showcase](https://freesewing.org/showcase/) to the website:
- Create a new folder in the `org/showcase` directory of [our markdown repository](https://github.com/freesewing/markdown/)
- Add an `en.md` markdown file to this folder
- Add one of more images to the folder
- Add the frontmatter to the file
- Add the body of the file
Let's look at each step in detail:
## Create a new folder for the showcase
Our [markdown repository](https://github.com/freesewing/markdown/) holds all content
for both freesewing.org and freesewing.dev.
The content for showcases on freesewing.org is in the `org/showcase` folder.
You'll find a bunch of directories here for all the existing showcases.
Create a new one keeping in mind that this will determine the URL under which the showcase
is available. So:
- No spaces
- No uppercase
- Stick to `a-z` and `-` to be safe
## Add an `en.md` file to the folder
Create an empty file in this folder and name it `en.md`.
## Add one of more images to the folder
Add the images you want to use to the folder.
<Note>We prefer if you use lowercase for all filenames</Note>
## Add the frontmatter
Frontmatter is metadata that we add to the top of the file.
Please refere to [working with frontmatter](/editors/frontmatter) is you're not sure how to use it.
The following fields need to be filled in:
| Name | Description |
| ---- | ----------- |
| `date` | Must be in format `YYYY-MM-DD` |
| `title` | Title of the showcase |
| `img` | Filename of the main image. Must be placed in the folder of the showcase |
| `caption` | The caption that will go below the image |
| `patterns` | An array of designs/patterns that are being showcased. Lowercase only |
| `author` | FreeSewing username of the author |
Below is an example:
```md
---
date: 2018-09-29
title: Yoga Outfit by Paul
img: showcase.jpg
caption: "Aaron and Bruce yoga set with stripes by Paul (up-side-down)"
patterns: [aaron,bruce]
author: Tiger751023
---
```
Add the frontmatter to the top of the `en.md` file.
## Add the body
Below the frontmatter, you can write the body of your post, [using markdown](/editors/markdown/).
<Tip>
You can look at [one of the many showcases](https://github.com/freesewing/markdown/tree/develop/org/showcase) for examples.
</Tip>