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,12 +1,15 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Code of Conduct
|
||||
for: contributors
|
||||
icons:
|
||||
- face
|
||||
- heart
|
||||
about: |
|
||||
|
||||
* face
|
||||
* heart
|
||||
about: |
|
||||
FreeSewing's code of conduct is based on the [contributor covenant](https://www.contributor-covenant.org/)
|
||||
---
|
||||
|
||||
***
|
||||
|
||||
<ReadMore title="The FreeSewing Code of Conduct" />
|
||||
|
||||
|
|
@ -20,6 +23,7 @@ This Code of Conduct is an almost verbatim copy of the [Contributor Covenant][ho
|
|||
available at [http://contributor-covenant.org/version/2/0][version]
|
||||
|
||||
[homepage]: http://contributor-covenant.org
|
||||
|
||||
[version]: http://contributor-covenant.org/version/2/0/
|
||||
|
||||
</Note>
|
||||
|
|
|
|||
|
|
@ -1,13 +1,16 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Correction
|
||||
order: 10
|
||||
---
|
||||
---------
|
||||
|
||||
##### Community Impact
|
||||
|
||||
Use of inappropriate language or other behavior
|
||||
deemed unprofessional or unwelcome in the community.
|
||||
|
||||
##### Consequence
|
||||
|
||||
A private, written warning from community leaders,
|
||||
providing clarity around the nature of the violation and an
|
||||
explanation of why the behavior was inappropriate.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Enforcement Guidelines
|
||||
order: 60
|
||||
---
|
||||
---------
|
||||
|
||||
Community leaders will follow these Community Impact Guidelines
|
||||
in determining the consequences for any action they deem
|
||||
|
|
|
|||
|
|
@ -1,13 +1,16 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Permanent ban
|
||||
order: 40
|
||||
---
|
||||
---------
|
||||
|
||||
##### Community Impact
|
||||
|
||||
Demonstrating a pattern of violation of
|
||||
community standards, including sustained inappropriate behavior,
|
||||
harassment of an individual, or aggression toward or
|
||||
disparagement of classes of individuals.
|
||||
|
||||
##### Consequence
|
||||
|
||||
A permanent ban from any sort of public interaction within the community.
|
||||
|
|
|
|||
|
|
@ -1,13 +1,16 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Temporary ban
|
||||
order: 30
|
||||
---
|
||||
---------
|
||||
|
||||
##### Community Impact
|
||||
|
||||
A serious violation of community standards,
|
||||
including sustained inappropriate behavior.
|
||||
|
||||
##### Consequence
|
||||
|
||||
A temporary ban from any sort of interaction or
|
||||
public communication with the community for a specified period
|
||||
of time.
|
||||
|
|
@ -17,4 +20,3 @@ involved, including unsolicited interaction with those enforcing
|
|||
the Code of Conduct, is allowed during this period.
|
||||
|
||||
Violating these terms may lead to a permanent ban.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,13 +1,16 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Warning
|
||||
order: 20
|
||||
---
|
||||
---------
|
||||
|
||||
##### Community Impact
|
||||
|
||||
A violation through a single incident or series of actions.
|
||||
|
||||
##### Consequence
|
||||
A warning with consequences for continued behavior.
|
||||
|
||||
A warning with consequences for continued behavior.\
|
||||
No interaction with the people involved, including unsolicited
|
||||
interaction with those enforcing the Code of Conduct, for a
|
||||
specified period of time. This includes avoiding interactions
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Enforcement responsibilities
|
||||
order: 30
|
||||
---
|
||||
---------
|
||||
|
||||
Community leaders are responsible for clarifying and enforcing our standards
|
||||
of acceptable behavior and will take appropriate and fair corrective action
|
||||
|
|
|
|||
|
|
@ -1,16 +1,16 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Enforcement
|
||||
order: 50
|
||||
---
|
||||
---------
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior
|
||||
may be reported to the community leaders responsible for enforcement:
|
||||
|
||||
- Joost De Cock (joost@joost.at)
|
||||
- Sorcha Ní Dhubhghaill (nidhubhs@gmail.com)
|
||||
* Joost De Cock (joost@joost.at)
|
||||
* Sorcha Ní Dhubhghaill (nidhubhs@gmail.com)
|
||||
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and
|
||||
security of the reporter of any incident.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Our pledge
|
||||
order: 10
|
||||
---
|
||||
---------
|
||||
|
||||
We as members, contributors, and leaders of the FreeSewing community pledge
|
||||
to make participation in our community a harassment-free experience for everyone.
|
||||
|
|
@ -13,4 +14,3 @@ religion, or sexual identity and orientation.
|
|||
|
||||
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||
diverse, inclusive, and healthy community.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,20 +1,21 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Our standards
|
||||
order: 20
|
||||
---
|
||||
---------
|
||||
|
||||
Examples of behavior that contributes to a positive environment for our community include:
|
||||
|
||||
- Demonstrating empathy and kindness toward other people
|
||||
- Being respectful of differing opinions, viewpoints, and experiences
|
||||
- Giving and gracefully accepting constructive feedback
|
||||
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
|
||||
- Focusing on what is best not just for us as individuals, but for the overall community
|
||||
* Demonstrating empathy and kindness toward other people
|
||||
* Being respectful of differing opinions, viewpoints, and experiences
|
||||
* Giving and gracefully accepting constructive feedback
|
||||
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
|
||||
* Focusing on what is best not just for us as individuals, but for the overall community
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
- The use of sexualized language or imagery, and sexual attention or advances of any kind
|
||||
- Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
- Public or private harassment
|
||||
- Publishing others’ private information, such as a physical or email address, without their explicit permission
|
||||
- Other conduct which could reasonably be considered inappropriate in a professional setting
|
||||
* The use of sexualized language or imagery, and sexual attention or advances of any kind
|
||||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others’ private information, such as a physical or email address, without their explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a professional setting
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Scope
|
||||
order: 40
|
||||
---
|
||||
---------
|
||||
|
||||
This Code of Conduct applies within all FreeSewing community spaces, and also applies
|
||||
when an individual is officially representing the FreeSewing community in public spaces.
|
||||
|
|
@ -9,4 +10,3 @@ when an individual is officially representing the FreeSewing community in public
|
|||
Examples of representing our community include using an official e-mail address,
|
||||
posting via an official social media account, or acting as an appointed representative
|
||||
at an online or offline event.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: For contributors
|
||||
order: 1110
|
||||
---
|
||||
-----------
|
||||
|
||||
Thank you for being part of our community, and for wanting to contribute! ❤️
|
||||
|
||||
|
|
@ -12,8 +13,8 @@ We would love to have you on board, but before we get to that, let's look at wha
|
|||
|
||||
##### Contributor requirements
|
||||
|
||||
- Please respect [our community standards](https://freesewing.org/docs/various/community-standards/)
|
||||
- As a contributor, you must uphold [our Code of Conduct](/contributors/code-of-conduct/)
|
||||
* Please respect [our community standards](https://freesewing.org/docs/various/community-standards/)
|
||||
* As a contributor, you must uphold [our Code of Conduct](/contributors/code-of-conduct/)
|
||||
|
||||
</Note>
|
||||
|
||||
|
|
@ -23,14 +24,12 @@ With that out of the way, here's a few more things that are *good to know*:
|
|||
|
||||
##### Did you know?
|
||||
|
||||
- Nobody gets paid to work on/for FreeSewing. We are a 100% volunteer organisation.
|
||||
- We have patrons who support us financially, but all the money that comes in goes to charity --
|
||||
* Nobody gets paid to work on/for FreeSewing. We are a 100% volunteer organisation.
|
||||
* We have patrons who support us financially, but all the money that comes in goes to charity --
|
||||
See our [revenue pledge](https://freesewing.org/docs/various/pledge/) for details
|
||||
|
||||
</Tip>
|
||||
|
||||
|
||||
With the formalities out of the way, please continue
|
||||
to [Ways to contribute](/contributors/ways-to-contribute)
|
||||
or [Where to get help](/contributors/help/).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,13 +1,16 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Where to get help
|
||||
for: contributors
|
||||
icons:
|
||||
- help
|
||||
- discord
|
||||
about: |
|
||||
|
||||
* 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
|
||||
ask questions or share your feedback.
|
||||
|
|
@ -16,11 +19,8 @@ Many of the FreeSewing contributors hang out there, and since we're spread over
|
|||
different parts of the world, you're likely to find somebody there who can answer
|
||||
your question(s) at any given moment.
|
||||
|
||||
|
||||
<Tip>
|
||||
|
||||
If you want to report a problem, please [create an issue](https://github.com/freesewing/freesewing/issues/new).
|
||||
|
||||
</Tip>
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Backend
|
||||
---
|
||||
***
|
||||
|
||||
## title: Backend
|
||||
|
||||
[The FreeSewing backend](https://backend.freesewing.org/) handles all user data for freesewing.org.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Commit
|
||||
---
|
||||
***
|
||||
|
||||
## title: Commit
|
||||
|
||||
A [commit](https://github.com/git-guides/git-commit) is made every time somebody published an update to our source code.
|
||||
|
||||
The words is also used as a verb as in _to commit changes_.
|
||||
The words is also used as a verb as in *to commit changes*.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Contributor call (fscc)
|
||||
---
|
||||
***
|
||||
|
||||
## title: Contributor call (fscc)
|
||||
|
||||
The FreeSewing Contributor Call (fscc) is a
|
||||
bi-weekly conference call/zoom meeting with the FreeSewing contributors.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Contributor
|
||||
---
|
||||
***
|
||||
|
||||
## title: Contributor
|
||||
|
||||
Anybody who contributes to FreeSewing in a material way. Either with code contributions,
|
||||
or community building, or pattern design, and so on.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Design/Pattern
|
||||
---
|
||||
***
|
||||
|
||||
## title: Design/Pattern
|
||||
|
||||
The terms **pattern** and **design** somewhat overlap and their exact meaning
|
||||
depends on the context.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Developer
|
||||
---
|
||||
***
|
||||
|
||||
## title: Developer
|
||||
|
||||
Anybody who works with software code or wants to learn to do so.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Discord
|
||||
---
|
||||
***
|
||||
|
||||
## title: Discord
|
||||
|
||||
The name of our chat provider that powers our chat at https://discord.freesewing.org/
|
||||
|
||||
When you hear _discord_ just think _chat_.
|
||||
When you hear *discord* just think *chat*.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Editor
|
||||
---
|
||||
***
|
||||
|
||||
## title: Editor
|
||||
|
||||
A person who contributs to/with content. Either by writing blog posts or documentation,
|
||||
or posts for social media. But it can also be video editing or making illustrations.
|
||||
|
|
|
|||
|
|
@ -1,11 +1,14 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Terminology
|
||||
icons:
|
||||
- logo
|
||||
- terms
|
||||
for: contributors
|
||||
about: Terms and definitions that will help you navigate the world of FreeSewing
|
||||
---
|
||||
|
||||
* logo
|
||||
* terms
|
||||
for: contributors
|
||||
about: Terms and definitions that will help you navigate the world of FreeSewing
|
||||
|
||||
***
|
||||
|
||||
Below is a list of terms you may come across when working with FreeSewing with a
|
||||
link to a brief description:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Express
|
||||
---
|
||||
***
|
||||
|
||||
## title: Express
|
||||
|
||||
[Express](https://expressjs.com/) is a web framework for NodeJS.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: freesewing.dev
|
||||
---
|
||||
***
|
||||
|
||||
## title: freesewing.dev
|
||||
|
||||
Our website for developers.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: freesewing.org
|
||||
---
|
||||
***
|
||||
|
||||
## title: freesewing.org
|
||||
|
||||
Our website for makers.
|
||||
|
||||
|
|
@ -19,7 +19,7 @@ built with Gatsby.
|
|||
|
||||
## i18n
|
||||
|
||||
Short of _internationalisation_. within the context of FreeSewing, this mostly
|
||||
Short of *internationalisation*. within the context of FreeSewing, this mostly
|
||||
means translation, but can also relate to other intenationalisation concerns such
|
||||
as the type of units to use, or paper sizes, and so on.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: FreeSewing
|
||||
---
|
||||
***
|
||||
|
||||
## title: FreeSewing
|
||||
|
||||
FreeSewing refers to the community-driven open source project.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Frontend
|
||||
---
|
||||
***
|
||||
|
||||
## title: Frontend
|
||||
|
||||
A user-facing interface. Can refer to one of our websites, or our development environment.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Gatsby
|
||||
---
|
||||
***
|
||||
|
||||
## title: Gatsby
|
||||
|
||||
[Gatsby](https://www.gatsbyjs.com/) is a static-site generator for React.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: i18n
|
||||
---
|
||||
***
|
||||
|
||||
Short for _internationalisation_. Within the context of FreeSewing, this mostly
|
||||
## title: i18n
|
||||
|
||||
Short for *internationalisation*. Within the context of FreeSewing, this mostly
|
||||
means translation, but can also relate to other internationalisation concerns such
|
||||
as the type of units to use, or paper sizes, and so on.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Issue
|
||||
---
|
||||
***
|
||||
|
||||
## title: Issue
|
||||
|
||||
An issue is a sort of support ticket. It can be a bug report, a feature request, a question
|
||||
or problem report.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Javascript
|
||||
---
|
||||
***
|
||||
|
||||
## title: Javascript
|
||||
|
||||
The programming language in which FreeSewing is written. It can run in your
|
||||
browser, as well as outside of it with Node JS.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Made-to-measure
|
||||
---
|
||||
***
|
||||
|
||||
## title: Made-to-measure
|
||||
|
||||
Made to someone's (body) measurements, rather than based on specific sizes.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Markdown
|
||||
---
|
||||
***
|
||||
|
||||
## title: Markdown
|
||||
|
||||
A plain text markup format that is easy to read for computers and humans alike.
|
||||
It's a way to write things in plain text, yet make them look pretty in HTML.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Monorepo
|
||||
---
|
||||
***
|
||||
|
||||
## title: Monorepo
|
||||
|
||||
A monorepo is an organisational approach to software development where rather than
|
||||
having a multitude of repositories, a number of different software pieces are bundled
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Node
|
||||
---
|
||||
***
|
||||
|
||||
## title: Node
|
||||
|
||||
Node (or NodeJS) is a Javascript runtime that allows to use the language outside the browser.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Parametric pattern design
|
||||
---
|
||||
***
|
||||
|
||||
## title: Parametric pattern design
|
||||
|
||||
A design approach whereby sewing patterns are contructed based on parameters,
|
||||
and can adapt automatically when those parameters change.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Patron
|
||||
---
|
||||
***
|
||||
|
||||
## title: Patron
|
||||
|
||||
A person who supports FreeSewing financially.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Plugin
|
||||
---
|
||||
***
|
||||
|
||||
## title: Plugin
|
||||
|
||||
An extension to FreeSewing core that provides an extra feature of functionality.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Pull request
|
||||
---
|
||||
***
|
||||
|
||||
## title: Pull request
|
||||
|
||||
A pull request is a proposal to commit changes to a repository.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: React
|
||||
---
|
||||
***
|
||||
|
||||
## title: React
|
||||
|
||||
[React](https://reactjs.org/) is a Javascript framework to build user interfaces on the web.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Repo
|
||||
---
|
||||
***
|
||||
|
||||
## title: Repo
|
||||
|
||||
Short for [repository](/contributors/terms/repository/).
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Repository
|
||||
---
|
||||
***
|
||||
|
||||
## title: Repository
|
||||
|
||||
We develop our software collaboratively, and all code is available in Github in so-called repositories.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,9 +1,8 @@
|
|||
---
|
||||
title: Tiler
|
||||
---
|
||||
***
|
||||
|
||||
## title: Tiler
|
||||
|
||||
The FreeSewing tiler is responsible for taking a pattern and splitting it into different
|
||||
pages so it can be printed.
|
||||
|
||||
The tiler is a backend service that is independent from the main FreeSewing backend.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Translator
|
||||
---
|
||||
***
|
||||
|
||||
## title: Translator
|
||||
|
||||
Somebody who helps with our i18n efforts by translating from English to other languages.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Body ambassador
|
||||
---
|
||||
***
|
||||
|
||||
## title: Body ambassador
|
||||
|
||||
Maybe you’re unusually short or tall.
|
||||
Maybe you have a bit of a pot belly or very large breasts.
|
||||
|
|
@ -8,4 +8,3 @@ Maybe you have a disability that requires fit adjustments.
|
|||
|
||||
Whatever it is, if you represent a minority fitting issue you could
|
||||
represent this minority to make sure their needs are heard and understood.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Community building
|
||||
---
|
||||
***
|
||||
|
||||
## title: Community building
|
||||
|
||||
The FreeSewing community resides [on Discord](https://discord.freesewing.org/).
|
||||
Just being there to answer questions and chat with other people is a valuable part of community building.
|
||||
|
|
@ -8,4 +8,3 @@ Just being there to answer questions and chat with other people is a valuable pa
|
|||
We also can be found [in plenty of other places](https://freesewing.org/community/where/) where we'd love to have you join us.
|
||||
|
||||
Apart from being present in chat rooms and social media, you could also take on some responsibility on one or more platforms.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Design sewing patterns
|
||||
---
|
||||
***
|
||||
|
||||
## title: Design sewing patterns
|
||||
|
||||
Everybody wants us to add more patterns. But somebody has to design them.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
title: Develop sewing patterns
|
||||
---
|
||||
***
|
||||
|
||||
## title: Develop sewing patterns
|
||||
|
||||
You could program new designs for FreeSewing.
|
||||
If you're not afraid of Javascript and are happy to team up with a designer,
|
||||
you could work on a new pattern together.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Devops
|
||||
---
|
||||
***
|
||||
|
||||
## title: Devops
|
||||
|
||||
We have use a lot of automation from Github actions to automated deployment on Netlify.
|
||||
We also have some Ansible playbooks to run maintenance tasks.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Ways to contribute
|
||||
---
|
||||
***
|
||||
|
||||
## title: Ways to contribute
|
||||
|
||||
<Tip>
|
||||
|
||||
|
|
@ -32,6 +32,3 @@ We are happy to provide guidance to anyone who wants to learn,
|
|||
especially when doing so enables upwards social mobility.
|
||||
|
||||
</Note>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
---
|
||||
title: Make illustrations
|
||||
---
|
||||
***
|
||||
|
||||
## title: Make illustrations
|
||||
|
||||
Our documentation can always use some more/better illustrations to help people figure out how
|
||||
to make our patterns into garments.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
title: Language ambassador
|
||||
---
|
||||
***
|
||||
|
||||
## title: Language ambassador
|
||||
|
||||
You could represent FreeSewing in a non-English community.
|
||||
There, you can help answer questions or triage problem reports.
|
||||
Or you can point out where translations are missing.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Pattern amabassador
|
||||
---
|
||||
***
|
||||
|
||||
## title: Pattern amabassador
|
||||
|
||||
You could take charge of a specific FreeSewing design/pattern.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Pattern testing
|
||||
---
|
||||
***
|
||||
|
||||
## title: Pattern testing
|
||||
|
||||
You could make (a muslin for) our patterns prior to release to make sure everything is ok.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Project management
|
||||
---
|
||||
***
|
||||
|
||||
## title: Project management
|
||||
|
||||
There's a lot going on within the FreeSewing project and it's easy to forget about something.
|
||||
|
||||
|
|
@ -9,7 +9,6 @@ organize milestones, and so on.
|
|||
|
||||
This is helpful in more than one way:
|
||||
|
||||
- It reduces the cognitive load of the people implementing changes because they don't have to worry about forgetting things
|
||||
- It increases transparency by making it clear what sort of things are being worked on
|
||||
- It gives us that good feeling of closing the issue when the task is done
|
||||
|
||||
* It reduces the cognitive load of the people implementing changes because they don't have to worry about forgetting things
|
||||
* It increases transparency by making it clear what sort of things are being worked on
|
||||
* It gives us that good feeling of closing the issue when the task is done
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Proofreading
|
||||
---
|
||||
***
|
||||
|
||||
## title: Proofreading
|
||||
|
||||
You could check the original English text of translations for typos and/or grammar mistakes.
|
||||
You could propose improvements and watch over a consistent style and tone across FreeSewing’s documentation and written text.
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
---
|
||||
title: Report bugs
|
||||
---
|
||||
***
|
||||
|
||||
## title: Report bugs
|
||||
|
||||
Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/).
|
||||
Create an issue [in our monorepo](https://github.com/freesewing/freesewing/issues/new?assignees=&labels=%F0%9F%90%9B+bug&template=bug-report.md&title=Bug+report) if you've found one.
|
||||
Create an issue [in our monorepo](https://github.com/freesewing/freesewing/issues/new?assignees=\&labels=%F0%9F%90%9B+bug\&template=bug-report.md\&title=Bug+report) if you've found one.
|
||||
|
||||
Explain the problem and include additional details to help maintainers reproduce the problem:
|
||||
|
||||
|
|
@ -15,4 +15,3 @@ Provide more context by answering these questions:
|
|||
|
||||
* **Did the problem start happening recently** (e.g. it worked fine before but since the latest update it doesn't)
|
||||
* **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,9 +1,8 @@
|
|||
---
|
||||
title: Showcase our patterns
|
||||
---
|
||||
***
|
||||
|
||||
## title: Showcase our patterns
|
||||
|
||||
Anytime somebody has made one of our patterns, we like to showcase it on [freesewing.org](https://freesewing.org/showcase/).
|
||||
|
||||
Unpublished showcases are tracked as [GitHub issues](https://guides.github.com/features/issues/).
|
||||
Create an issue [in our monorepo](https://github.com/freesewing/freesewing/issues/new?assignees=&labels=%F0%9F%91%8D+good+first+issue%2C+%F0%9F%93%B8+showcase%2C+%F0%9F%A4%97+community&template=showcase-template.md&title=Create+showcase+from+this+content) when you've made one of our patterns, or have come across pictures from another maker who did.
|
||||
|
||||
Create an issue [in our monorepo](https://github.com/freesewing/freesewing/issues/new?assignees=\&labels=%F0%9F%91%8D+good+first+issue%2C+%F0%9F%93%B8+showcase%2C+%F0%9F%A4%97+community\&template=showcase-template.md\&title=Create+showcase+from+this+content) when you've made one of our patterns, or have come across pictures from another maker who did.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Writing for freesewing.dev
|
||||
---
|
||||
***
|
||||
|
||||
## title: Writing for freesewing.dev
|
||||
|
||||
You could write documentation for freesewing.dev, our developers website.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Technical writing
|
||||
---
|
||||
***
|
||||
|
||||
## title: Technical writing
|
||||
|
||||
<ReadMore list />
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Writing for freesewing.org
|
||||
---
|
||||
***
|
||||
|
||||
## title: Writing for freesewing.org
|
||||
|
||||
You could write documentation for freesewing.org, our makers website.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
---
|
||||
title: Translation
|
||||
---
|
||||
***
|
||||
|
||||
## title: Translation
|
||||
|
||||
You could translate FreeSewing into one of its additional languages
|
||||
(French, German, Dutch, Spanish). Or if you’re ambitious, add a new one.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,15 +1,14 @@
|
|||
---
|
||||
title: Triage issues
|
||||
---
|
||||
***
|
||||
|
||||
## title: Triage issues
|
||||
|
||||
Triaging issues is a great way to get involved in FreeSewing. You can do tasks such as:
|
||||
|
||||
- Making sure issues are properly labeled
|
||||
- Ensuring they have a good title that explains the issue in brief
|
||||
- Assigning issues to people to make sure they are tended to
|
||||
- Keeping an eye on stale issues, and either updating or closing them
|
||||
- Assigning issues to milestones so we can plan our releases
|
||||
* Making sure issues are properly labeled
|
||||
* Ensuring they have a good title that explains the issue in brief
|
||||
* Assigning issues to people to make sure they are tended to
|
||||
* Keeping an eye on stale issues, and either updating or closing them
|
||||
* Assigning issues to milestones so we can plan our releases
|
||||
|
||||
All FreeSewing contributors have triage permissions that allows them to do this.
|
||||
If you don't have the rights, or bump into any issues, [reach out to us on Discord](https://discord.freesewing.org).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: UI / UX Webdesign
|
||||
---
|
||||
***
|
||||
|
||||
## title: UI / UX Webdesign
|
||||
|
||||
You could help us make our website and tools pretty and improve the user experience.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: The freesewing backend
|
||||
---
|
||||
***
|
||||
|
||||
## title: The freesewing backend
|
||||
|
||||
<Fixme>Under construction</Fixme>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: The freesewing.dev website
|
||||
---
|
||||
***
|
||||
|
||||
## title: The freesewing.dev website
|
||||
|
||||
<Fixme>Under construction</Fixme>
|
||||
|
|
|
|||
|
|
@ -1,16 +1,17 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: For developers
|
||||
order: 1120
|
||||
---
|
||||
-----------
|
||||
|
||||
Welcome to the FreeSewing documentation for developers.
|
||||
|
||||
Our core library is a toolbox for parametric sewing pattern design.
|
||||
Here's some of the most relevant reference documentation:
|
||||
|
||||
- [Core API reference](/reference/api/)
|
||||
- [Pattern configuration file](/reference/config/)
|
||||
- [Settings](/reference/settings/)
|
||||
* [Core API reference](/reference/api/)
|
||||
* [Pattern configuration file](/reference/config/)
|
||||
* [Settings](/reference/settings/)
|
||||
|
||||
We have a [Pattern design tutorial](/tutorials/pattern-design/) that is a
|
||||
good way to familiarize yourself with the FreeSewing platform.
|
||||
|
|
@ -23,5 +24,3 @@ If you are interested the FreeSewing project as a whole, the following links
|
|||
cover different aspects of our setup:
|
||||
|
||||
<ReadMore list />
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: The freesewing.org website
|
||||
---
|
||||
***
|
||||
|
||||
## title: The freesewing.org website
|
||||
|
||||
<Fixme>Under construction</Fixme>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: The freesewing on-demand tiler
|
||||
---
|
||||
***
|
||||
|
||||
## title: The freesewing on-demand tiler
|
||||
|
||||
<Fixme>Under construction</Fixme>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Our tile command line tool
|
||||
---
|
||||
***
|
||||
|
||||
## title: Our tile command line tool
|
||||
|
||||
<Fixme>Under construction</Fixme>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Content sources
|
||||
---
|
||||
***
|
||||
|
||||
## title: Content sources
|
||||
|
||||
As an editor, you need to know where you can find/edit what type of content.
|
||||
|
||||
|
|
@ -10,9 +10,9 @@ Our [freesewing monorepo](https://github/freesewing/freesewing) holds the majori
|
|||
|
||||
Here you can find:
|
||||
|
||||
- Content for freesewing.org: in the `markdown/org` folder
|
||||
- Content for freesewing.dev: in the `markdown/dev` folder
|
||||
- Strings used throughout the software: in the `packages/i18n/src/locales` folder
|
||||
* Content for freesewing.org: in the `markdown/org` folder
|
||||
* Content for freesewing.dev: in the `markdown/dev` folder
|
||||
* Strings used throughout the software: in the `packages/i18n/src/locales` folder
|
||||
|
||||
<Note>
|
||||
|
||||
|
|
@ -29,14 +29,13 @@ The rest will be created automatically.
|
|||
|
||||
FreeSewing uses [the Strapi content management system](https://strapi.io/) as a headless content management system for various posts:
|
||||
|
||||
- For blog posts on freesewing.org
|
||||
- For showcase posts on freesewing.org
|
||||
- For blog posts on freesewing.dev
|
||||
- For newsletter editions
|
||||
* For blog posts on freesewing.org
|
||||
* For showcase posts on freesewing.org
|
||||
* For blog posts on freesewing.dev
|
||||
* For newsletter editions
|
||||
|
||||
The Strapi instance is available at [posts.freesewing.org](https://posts.freesewing.org)
|
||||
|
||||
|
||||
## Emails sent from our backend
|
||||
|
||||
The last bit of content is emails that are sent out from our backend systems.
|
||||
|
|
|
|||
|
|
@ -1,16 +1,17 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: For editors
|
||||
order: 1130
|
||||
---
|
||||
-----------
|
||||
|
||||
Content is king, and as an *editor* content is your baby.
|
||||
|
||||
We have a few different [content sources](/editor/content-sources/) that all have their own
|
||||
specific use-cases, but in general content is one of:
|
||||
|
||||
- 95% **Markdown**: Used for the vast majority of our content.
|
||||
- 4% **YAML**: Used for the internationalisation of our software.
|
||||
- 1% **HTML**: Used in specific places that don't requires internationalisation.
|
||||
* 95% **Markdown**: Used for the vast majority of our content.
|
||||
* 4% **YAML**: Used for the internationalisation of our software.
|
||||
* 1% **HTML**: Used in specific places that don't requires internationalisation.
|
||||
|
||||
You guessed it, if you know how to work with markdown, you are already covering
|
||||
95% of all our content. As such, [our Markdown guide](/editors/markdown/) is mandatory
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Adding a blog post
|
||||
for: editors
|
||||
---
|
||||
------------
|
||||
|
||||
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/).
|
||||
|
||||
If you don't have a Strapi account (yet), [reach out to us on Discord](https://discord.freesewing.org).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Common tasks for editors
|
||||
---
|
||||
***
|
||||
|
||||
## title: Common tasks for editors
|
||||
|
||||
Below is a list of commons tasks for editors
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: About frontmatter
|
||||
order: 10
|
||||
---
|
||||
---------
|
||||
|
||||
Frontmatter is a way to add metadata to markdown documents.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
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:
|
||||
|
|
@ -13,4 +14,3 @@ categories:
|
|||
- anothercat
|
||||
- somethingelse
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Mult-line text
|
||||
order: 40
|
||||
---
|
||||
---------
|
||||
|
||||
To add multi-line text in frontmatter, use a `|` character,
|
||||
and prefix the lines by spaces:
|
||||
|
|
@ -11,6 +12,3 @@ about: |
|
|||
This is a multi-line text
|
||||
that will be assigned to the about key
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
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:
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Adding a showcase on freesewing.org
|
||||
for: editors
|
||||
---
|
||||
------------
|
||||
|
||||
Showcase posts have been migrated to [Strapi](https://strapi.io/), a headless CMS system.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Code and code blocks
|
||||
order: 80
|
||||
---
|
||||
---------
|
||||
|
||||
Especially for our developer documentation, there's a lot of times we include source code
|
||||
in the documentation.
|
||||
|
|
@ -9,26 +10,20 @@ You can make these look pretty by using a code block.
|
|||
|
||||
The basic use is to wrap your code in three backtick characters on a line:
|
||||
|
||||
````
|
||||
```
|
||||
let me = 'you'
|
||||
```
|
||||
````
|
||||
```
|
||||
let me = 'you'
|
||||
```
|
||||
|
||||
Gives you:
|
||||
|
||||
```
|
||||
let me = 'you'
|
||||
```
|
||||
let me = 'you'
|
||||
|
||||
This is a generic code block. But we also support syntax highlighting.
|
||||
To do so, add the language specifier after the opening backticks:
|
||||
|
||||
````
|
||||
```js
|
||||
let me = 'you'
|
||||
```
|
||||
````
|
||||
```js
|
||||
let me = 'you'
|
||||
```
|
||||
|
||||
To get:
|
||||
|
||||
|
|
@ -38,16 +33,13 @@ let me = 'you'
|
|||
|
||||
The following language codes are supported:
|
||||
|
||||
- `js` for Javascript code
|
||||
- `md` for Markdown
|
||||
- `html` for HTML
|
||||
- `svg` for SVG
|
||||
- `bash` for Bash or shell scripts
|
||||
- `mdx` for MDX
|
||||
- `jsx` for JSX
|
||||
- `json` for JSON
|
||||
- `js-error` for a Javascript error
|
||||
- `js-trace` for a Javascript stack trace
|
||||
|
||||
|
||||
|
||||
* `js` for Javascript code
|
||||
* `md` for Markdown
|
||||
* `html` for HTML
|
||||
* `svg` for SVG
|
||||
* `bash` for Bash or shell scripts
|
||||
* `mdx` for MDX
|
||||
* `jsx` for JSX
|
||||
* `json` for JSON
|
||||
* `js-error` for a Javascript error
|
||||
* `js-trace` for a Javascript stack trace
|
||||
|
|
|
|||
|
|
@ -1,9 +1,10 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Custom components
|
||||
order: 90
|
||||
---
|
||||
---------
|
||||
|
||||
The way we render markdown on our websites is through the use of [MDX](https://mdxjs.com/).
|
||||
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*.
|
||||
|
||||
Such custom components allow us to put things in Markdown content that would
|
||||
|
|
@ -20,4 +21,3 @@ line at the start and finish. If you don't, the custom component will still work
|
|||
content inside of it will not be parsed as Markdown.
|
||||
|
||||
</Tip>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Example
|
||||
order: 90
|
||||
---
|
||||
---------
|
||||
|
||||
Embeds an example -- a part of our `example` pattern that is used to
|
||||
illustrate the core API documentation.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Fixme
|
||||
order: 40
|
||||
---
|
||||
---------
|
||||
|
||||
```md
|
||||
<Fixme>
|
||||
|
|
@ -15,7 +16,7 @@ I indicate that something needs work or improvement
|
|||
<Fixme>
|
||||
|
||||
##### I am a FIXME
|
||||
|
||||
I indicate that something needs work or improvement
|
||||
|
||||
</Fixme>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Hashtag
|
||||
order: 60
|
||||
---
|
||||
---------
|
||||
|
||||
Typically used on our community pages:
|
||||
|
||||
|
|
@ -9,8 +10,6 @@ Typically used on our community pages:
|
|||
<Hashtag tag='WeAreFreeSewing' />
|
||||
```
|
||||
|
||||
Adds our _community_ font and color:
|
||||
Adds our *community* font and color:
|
||||
|
||||
<Hashtag tag='WeAreFreeSewing' />
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Note
|
||||
order: 10
|
||||
---
|
||||
---------
|
||||
|
||||
```md
|
||||
<Note>
|
||||
|
|
@ -15,6 +16,7 @@ I point out things
|
|||
<Note>
|
||||
|
||||
##### I am a note
|
||||
|
||||
I point out things
|
||||
|
||||
</Note>
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: ReadMore
|
||||
order: 70
|
||||
---
|
||||
---------
|
||||
|
||||
This component will list child pages of the current page.
|
||||
|
||||
|
|
@ -10,6 +11,7 @@ This component will list child pages of the current page.
|
|||
```md
|
||||
<ReadMore />
|
||||
```
|
||||
|
||||
<ReadMore />
|
||||
|
||||
##### With custom title
|
||||
|
|
@ -19,6 +21,7 @@ You can customize the title by passing a `title` prop:
|
|||
```md
|
||||
<ReadMore title='Example pages'/>
|
||||
```
|
||||
|
||||
<ReadMore title='Example pages'/>
|
||||
|
||||
##### As a list
|
||||
|
|
@ -29,6 +32,7 @@ prop which returns the pages as a list:
|
|||
```md
|
||||
<ReadMore list />
|
||||
```
|
||||
|
||||
<ReadMore list />
|
||||
|
||||
##### As a recursive list
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Example page 1
|
||||
---
|
||||
***
|
||||
|
||||
## title: Example page 1
|
||||
|
||||
This page is here to illustrate the use of [the `ReadMore` custom component](/editors/markdown/custom-components/readmore/).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Example page 2
|
||||
---
|
||||
***
|
||||
|
||||
## title: Example page 2
|
||||
|
||||
This page is here to illustrate the use of [the `ReadMore` custom component](/editors/markdown/custom-components/readmore/).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Sub-example page 1
|
||||
---
|
||||
***
|
||||
|
||||
## title: Sub-example page 1
|
||||
|
||||
This page is here to illustrate the use of [the `ReadMore` custom component](/editors/markdown/custom-components/readmore/).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Sub-example page 2
|
||||
---
|
||||
***
|
||||
|
||||
## title: Sub-example page 2
|
||||
|
||||
This page is here to illustrate the use of [the `ReadMore` custom component](/editors/markdown/custom-components/readmore/).
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Tip
|
||||
order: 20
|
||||
---
|
||||
---------
|
||||
|
||||
```md
|
||||
<Tip>
|
||||
|
|
@ -15,7 +16,7 @@ I give great advice
|
|||
<Tip>
|
||||
|
||||
##### I am a tip
|
||||
|
||||
I give great advice
|
||||
|
||||
</Tip>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Warning
|
||||
order: 30
|
||||
---
|
||||
---------
|
||||
|
||||
```md
|
||||
<Warning>
|
||||
|
|
@ -15,7 +16,7 @@ Ignore me at your own peril
|
|||
<Warning>
|
||||
|
||||
##### I am a warning
|
||||
|
||||
Ignore me at your own peril
|
||||
|
||||
</Warning>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: YouTube
|
||||
order: 50
|
||||
---
|
||||
---------
|
||||
|
||||
This components will embed videos and playlists responsively.
|
||||
|
||||
|
|
@ -24,4 +25,3 @@ Embed a playlist:
|
|||
```
|
||||
|
||||
<YouTube id='RDRz6ShSftDlI' playlist />
|
||||
|
||||
|
|
|
|||
|
|
@ -1,18 +1,21 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Markdown guide
|
||||
for: contributors
|
||||
order: 900
|
||||
icons:
|
||||
- edit
|
||||
- markdown
|
||||
about: |
|
||||
|
||||
* 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
|
||||
---
|
||||
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.
|
||||
It is designed to be easily readable by humans, and computers alike.
|
||||
|
|
@ -26,4 +29,3 @@ In this guide, we'll look at the following topics:
|
|||
|
||||
This will be enough to get you started. If you'd like to learn more,
|
||||
visit [markdownguide.org](https://www.markdownguide.org/).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Headings
|
||||
order: 40
|
||||
---
|
||||
---------
|
||||
|
||||
Prefix your line with a number of `#` characters to determine the header level.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Images
|
||||
order: 70
|
||||
---
|
||||
---------
|
||||
|
||||
Images are like links, just prefix them with an exclamation mark.
|
||||
The part between square brackets is the image caption or alt-text.
|
||||
|
|
@ -19,4 +20,3 @@ text where you are including the image. That way, you just need to specify
|
|||
the image name, and not the path to its location.
|
||||
|
||||
</Tip>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,16 +1,18 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Italics and bold
|
||||
order: 30
|
||||
---
|
||||
---------
|
||||
|
||||
```md
|
||||
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**.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Line breaks
|
||||
order: 20
|
||||
---
|
||||
---------
|
||||
|
||||
If you want to force a linebreak, but not a new paragraph,
|
||||
simply leave 2 spaces at the end of the line.
|
||||
|
|
@ -11,6 +12,5 @@ Like
|
|||
this.
|
||||
```
|
||||
|
||||
Like
|
||||
Like\
|
||||
this.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
---
|
||||
***
|
||||
|
||||
title: Links
|
||||
order: 60
|
||||
---
|
||||
---------
|
||||
|
||||
Links combine square brackets for the link text with round brackets for the destination.
|
||||
|
||||
```md
|
||||
[Like this](https://freesewing.org)
|
||||
```
|
||||
[Like this](https://freesewing.org)
|
||||
|
||||
[Like this](https://freesewing.org)
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue