courses/30.about/10.contributing/page.en.md

title	slug
Contributing	contributing

How it works

• 📖 Flat files
  • enhanced markdown for content
  • YAML frontmatter for metadata
• 🦊 Continuous integration using GitLab (Ruby)
• 🌎 Decentralized versioning using Git
  • asynchronous and offline collaboration
  • scales to thousands of contributors
• 🚀 HTML generation using Grav (PHP)
  • basically the new WordPress, but much better
  • vibrant and growing community in 2019

Data Flow

graph LR

User(Teacher)
Website[M3P2 Website]
Local[Local Website]
Git[Git]
GitLab[GitLab]

User --> |contributes via| Git
User --> |contributes via| GitLab
User --> |contributes via| Local

Local --> |triggers| Git
Git --> |triggers| GitLab
GitLab --> |updates| Website

🐠

Enhanced Markdown

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)

![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.

Emoticons ✨

Just type or paste the unicode character, modern browsers will do the rest.

Here's a handy list: https://unicode.org/emoji/charts/full-emoji-list.html

LateX

You can use LateX in the courses.

For example, the following

$E = m \cdot c^2$

yields $E = m \cdot c^2$

!!!! Make sure you 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.