Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Courses
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
6
Issues
6
List
Board
Labels
Milestones
Merge Requests
4
Merge Requests
4
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
M3P2
Courses
Commits
aa7d4ffb
Commit
aa7d4ffb
authored
Apr 06, 2019
by
Goutte
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add LateX and mermaid flowcharts to the contributing guide.
parent
63b01a27
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
127 additions
and
32 deletions
+127
-32
page.en.md
30.about/10.contributing/page.en.md
+127
-32
No files found.
30.about/10.contributing/page.en.md
View file @
aa7d4ffb
...
...
@@ -21,7 +21,7 @@ slug: contributing
```
mermaid
graph
LR
graph
RL
User(Teacher)
Website[M3P2 Website]
...
...
@@ -50,34 +50,40 @@ The point of Markdown (compared to raw HTML) is the _readability of the source_.
### Markdown Cheatsheet
```
# Header like h1
## Header like h2
…
###### Header like h6
_italic_
__underlined__
*bold*
**strong**
~~strike-through~~
Go [there](https://…)
[Current chapter](.)
[Parent chapter](..)
[Sibling chapter](../another-chapter)
[Child chapter](chapter)
[Anchor in the page](#slug-of-header)

! blue notice
!! green notice
!!! orange notice
!!!! red notice
!!!!
!!!! another line on the red notice
```
# Header like h1
## Header like h2
…
###### Header like h6
_italic_
__underlined__
*bold*
**strong**
~~strike-through~~
`inline->code()`
```python
import antigravity
antigravity.apply()
```
Go [there](https://…)
[Current chapter](.)
[Parent chapter](..)
[Sibling chapter](../another-chapter)
[Child chapter](chapter)
[Anchor in the page](#slug-of-header)

! 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).
...
...
@@ -101,7 +107,96 @@ For example, the following
yields $E = m
\c
dot 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.
!!!!
!!!! 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
```
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment