🇨🇴 Una base de datos de cursos en diferentes lenguajes. 🇫🇷 Une base de données de cours dans différents langages. 🇳🇴 En database med kurs på forskjellige språk. 🇺🇸 A flat-file database of courses in multiple languages.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

107 lines
2.1 KiB

7 years ago
7 years ago
  1. ---
  2. title: Contributing
  3. slug: contributing
  4. ---
  5. ## How it works
  6. - 📖 *Flat files*
  7. - [enhanced markdown](#enhanced-markdown) for content
  8. - [YAML frontmatter](https://learn.getgrav.org/15/content/headers) for metadata
  9. - 🦊 *Continuous integration* using [GitLab (Ruby)](https://m3p2.ljbac.com)
  10. - 🌎 *Decentralized versioning* using [Git](https://en.wikipedia.org/wiki/Git)
  11. - asynchronous and offline collaboration
  12. - scales to thousands of contributors
  13. - 🚀 *HTML generation* using [Grav (PHP)](https://m3p2.ljbac.com/m3p2/grav-website)
  14. - basically the new WordPress, _but much better_
  15. - vibrant and growing community in 2019
  16. ## Data Flow
  17. ```mermaid
  18. graph LR
  19. User(Teacher)
  20. Website[M3P2 Website]
  21. Local[Local Website]
  22. Git[Git]
  23. GitLab[GitLab]
  24. User --> |contributes via| Git
  25. User --> |contributes via| GitLab
  26. User --> |contributes via| Local
  27. Local --> |triggers| Git
  28. Git --> |triggers| GitLab
  29. GitLab --> |updates| Website
  30. ```
  31. <marquee>🐠</marquee>
  32. ## Enhanced Markdown
  33. The point of Markdown (compared to raw HTML) is the _readability of the source_.
  34. ### Markdown Cheatsheet
  35. ```
  36. # Header like h1
  37. ## Header like h2
  38. ###### Header like h6
  39. _italic_
  40. __underlined__
  41. *bold*
  42. **strong**
  43. ~~strike-through~~
  44. Go [there](https://…)
  45. [Current chapter](.)
  46. [Parent chapter](..)
  47. [Sibling chapter](../another-chapter)
  48. [Child chapter](chapter)
  49. [Anchor in the page](#slug-of-header)
  50. ![Description of the image](local-image.png)
  51. ! blue notice
  52. !! green notice
  53. !!! orange notice
  54. !!!! red notice
  55. !!!!
  56. !!!! another line on the red notice
  57. ```
  58. > More at Gitlab's [Markdown documentation](https://docs.gitlab.com/ee/user/markdown.html).
  59. ### Emoticons ✨
  60. Just type or paste the unicode character, modern browsers will do the rest.
  61. Here's a handy list: https://unicode.org/emoji/charts/full-emoji-list.html
  62. ### LateX
  63. You can use LateX in the courses.
  64. For example, the following
  65. $E = m \cdot c^2$
  66. yields $E = m \cdot c^2$
  67. !!!! Make sure you add trailing spaces to expressions like `\cdot`,
  68. !!!! or you'll end up with broken formulas.
  69. !!!!
  70. !!!! Generous spacing also improves the readability of the source, and costs nothing.