Skip to content

Latest commit

 

History

History
75 lines (57 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

75 lines (57 loc) · 2.06 KB

Quelques infos sur la contribution

Initier votre article

1- Créer un dossier portant le nom de votre article dans cookbook 2- Créer dans ce dossier un fichier index.md en partant du template template.md 3- Editer votre fichier index.md :) 4- Lance l'app avec npm run start pour vérifier le rendu de ton article

Le format du template d'article

Le format du template d'article - le cartouche

Il est important de laisser les noms des attributs sur chaque ligne. On ne modifie que ce qui vient après.

---
title: Lorem Ipsum 
description: Un article a propos de Lorem ipsum
tags: ['recipe']
date: 2021-06-19
layout: layouts/cookbook.njk
---
Attribut Description
title Titre de la recette
description Description succincte qui sera utilisée dans la liste des recettes
tags Laisser celui du template (tags: ['recipe']) dans un premier temps
date La date de création de l'article doit être au format AAAA-MM-JJ
layout Laisser celui du template (layouts/cookbook.njk) dans un premier temps

Le format du template d'article - le contenu

Le contenu doit respecter la syntaxe markdown

Note: Le HTML est interprété, vous pouvez donc (avec parcimonie) ajouter des balises dans vos articles.

Quelques exemples de syntaxe markdown :


# Titre
## Titre 2
### Titre 3
#### Titre 4

| Syntax      | Description |
| ----------- | ----------- |
| Header      | Title       |
| Paragraph   | Text        |

    ```html
        <p>
        exemple de code HTML 
        </p>
    ```

> citation

[Lien](url du lien)

Cas particulier des images


Les images sont stockées dans le même dossier que le fichier md de l'article.

Pour y accéder après le build il faut placer l'image dans une balise ayant comme classe CSS "illustration--centered" et indiquer dans l'URL / comme dans l'exemple ci-dessous:

<p class="illustration--centered">
  <img width="300px" src="/sticky-footer.png" alt="Ma description" >
</p>