Commit aa7d4ffb authored by Goutte's avatar Goutte

Add LateX and mermaid flowcharts to the contributing guide.

parent 63b01a27
...@@ -21,7 +21,7 @@ slug: contributing ...@@ -21,7 +21,7 @@ slug: contributing
```mermaid ```mermaid
graph LR graph RL
User(Teacher) User(Teacher)
Website[M3P2 Website] Website[M3P2 Website]
...@@ -50,34 +50,40 @@ The point of Markdown (compared to raw HTML) is the _readability of the source_. ...@@ -50,34 +50,40 @@ The point of Markdown (compared to raw HTML) is the _readability of the source_.
### Markdown Cheatsheet ### Markdown Cheatsheet
``` # Header like h1
# Header like h1 ## Header like h2
## Header like h2
###### Header like h6
###### Header like h6
_italic_
_italic_ __underlined__
__underlined__ *bold*
*bold* **strong**
**strong** ~~strike-through~~
~~strike-through~~
`inline->code()`
Go [there](https://…)
[Current chapter](.) ```python
[Parent chapter](..) import antigravity
[Sibling chapter](../another-chapter) antigravity.apply()
[Child chapter](chapter) ```
[Anchor in the page](#slug-of-header)
![Description of the image](local-image.png) Go [there](https://…)
[Current chapter](.)
! blue notice [Parent chapter](..)
!! green notice [Sibling chapter](../another-chapter)
!!! orange notice [Child chapter](chapter)
!!!! red notice [Anchor in the page](#slug-of-header)
!!!!
!!!! another line on the red notice ![Description of the image](local-image.png)
```
! blue notice
!! green notice
!!! orange notice
!!!! red notice
!!!!
!!!! another line on the red notice
> More at Gitlab's [Markdown documentation](https://docs.gitlab.com/ee/user/markdown.html). > More at Gitlab's [Markdown documentation](https://docs.gitlab.com/ee/user/markdown.html).
...@@ -101,7 +107,96 @@ For example, the following ...@@ -101,7 +107,96 @@ For example, the following
yields $E = m \cdot c^2$ yields $E = m \cdot c^2$
!!!! Make sure you add trailing spaces to expressions like `\cdot`, !!!! Make sure to *add trailing spaces* to expressions like `\cdot`,
!!!! or you'll end up with broken formulas. !!!! or you'll end up with broken formulas.
!!!!
!!!! Generous spacing also improves the readability of the source, and costs nothing.
#### Multiline
The preferred way is to use a `math` code block, like so:
```math
\overrightarrow{F}_{L} = q \cdot (
\overrightarrow{E}
+
\overrightarrow{v}
\wedge
\overrightarrow{B}
)
```
The `math` code block also works in GitLab's preview.
_You can also use the `$$` syntax, but GitLab won't understand it._
!! Generous spacing greatly improves the readability of the source.
### Flowcharts
> _Any resemblance to real persons, living or dead, is purely coincidental._
```mermaid
graph TB
subgraph M3P2
Draft[Draft]
File[File]
Website[Website]
Pipeline[Pipeline]
end
Sponsor((Sponsor))
Teacher((Teacher))
Student((Student))
Engineer((Engineer))
Student --> |reads| Website
Student --> |loves| Sponsor
Student --> |respects| Teacher
Student --> |complements| Draft
Teacher -.- Engineer
Sponsor --> |feeds| Teacher
Sponsor --> |feeds| Engineer
Teacher --> |reviews| Draft
File --> |triggers| Pipeline
Draft -.- File
Pipeline --> |updates| Website
Teacher --> |authors| File
Engineer --> |specifies| File
Engineer --> |maintains| Pipeline
Engineer --> |hosts| Website
```
```mermaid
graph TB
subgraph M3P2
Draft[Draft]
File[File]
Website[Website]
Pipeline[Pipeline]
end
Sponsor((Sponsor))
Teacher((Teacher))
Student((Student))
Engineer((Engineer))
Student --> |reads| Website
Student --> |loves| Sponsor
Student --> |respects| Teacher
Student --> |complements| Draft
Teacher -.- Engineer
Sponsor --> |feeds| Teacher
Sponsor --> |feeds| Engineer
Teacher --> |reviews| Draft
File --> |triggers| Pipeline
Draft -.- File
Pipeline --> |updates| Website
Teacher --> |authors| File
Engineer --> |specifies| File
Engineer --> |maintains| Pipeline
Engineer --> |hosts| Website
```
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment