diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..bb7e4437e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,157 @@ + + +## Git + +### The easy way + +Use Gitlab's WebIDE. +You won't be able to 100% accurately preview the result until you commit and the servers are updated. + +### The powerful way + +Run the website locally and preview your changes instantly. +Head over to the [sources of the server instance](https://m3p2.ljbac.com/m3p2/grav-website) to learn how to set it up. + + +## File Structure + +Each page is a directory. + + +### File names + +We define as *slug-case* what some call *kebab-case*. + +- lowercase +- alphanumeric +- joined with `-` +- `a-z`, no diacritics +- starts with a letter (probably best) + + +#### Directories + +`[.]` + +The numbers prefix can be ignored when building links, its purpose is to order sibling pages. + +Set the english slug ; localized slugs can be set in frontmatters like so: + +```yaml +title: Joyeux Noël! +slug: joyeux-noel +``` + + +#### Markdown files + +`