Ajouter un article en Markdown - SCIAM-FR/sciam-fr.github.io GitHub Wiki

Ajouter dans le sous-répertoire _post le fichier de l’article avec l’extension .md ou .markdown

Le nom du fichier doit être de la forme :

YYYY-MM-DD-nom-article.[md|markdown]

Warning
️ Toujours prévisualiser le rendu dans le blog en local. L’aperçu avec son outil préféré peut être parfois différents pour certaines fonctionnalités

 

Le contenu d’un article au format Markdown

Il débute par des méta-données démarquées entre deux triples tirets (Front matter)

Méta-données Rôle

author: xxx

L’identifiant de l’auteur (doit être défini dans le fichier _data/authors.yml)

title: xxx

Titre

layout: post

Le format d’affichage de la page

excerpt: xxx

Le résumé de l’article

tags: xxx ou [‘xxx’,’xyy’,’xyz’]

Les tags associés à l’article

toc: true|false

L’affichage ou non du sommaire (true par défaut)

vignette: xxx

Le nom du fichier de l’image utilisée comme vignette

date: 2022-11-02 15:40:19 +0100

La date qui vient écraser la date en préfixe du fichier. Peut être utilisée pour garantir l’ordre de tri des articles

published : true|false

Empêcher l’inclusion de l’article dans le site statique généré si la valeur est false

auteurs:

Liste des auteurs de l’article

---
layout: post
title: "Welcome to Jekyll!"
author: someone
date: 2022-11-02 15:40:19 +0100
tags: Welcome
excerpt: You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes.
toc: false
tags: ['Java', 'Pattern matching', 'Switch expressions', 'Java 14']
excerpt: 'Cet article vous dresse un panorama des évolutions majeures autour de Java au cours de ces dernières années. Parmi les nombreuses évolutions qui pourraient vous pousser à vouloir découvrir les version récentes du langage, celles que je trouve particulièrement intéressantes sont celles permettant d''améliorer la vitesse de développement et la lisibilité du code.'
vignette: java.jpeg
---

# Welcome to Jekyll

You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated.

 

Le sommaire

Le sommaire est généré par défaut pour tous les articles.

Pour le désactiver, il faut utiliser la valeur false à l’attribut toc:

Pour le sommaire en Markdown, il faut obligatoirement utiliser les titres en utilisant la syntaxe ♯♯, ♯♯♯, ♯♯♯♯, …​

 

Les images

Les images doivent être le sous-répertoire images.

TODO

 

La vignette

Les images des vignettes doivent être le sous-répertoire images/vignettes.

Dans un article en Markdown, définir l’attribut vignettes: dans les méta-données avec le nom du fichier

 

Les tags

Dans un article en Markdown, utiliser l’attribut tags: dans les méta-données

tags: ['Java', 'Pattern matching', 'Switch expressions', 'Java 14']

Attention : ils sont sensibles à la casse

 

Les articles multi-auteurs

Il faut indiquer les auteurs dans les méta-données dans une propriété auteurs

auteurs:
- antoinesd
- jmdoudoux
⚠️ **GitHub.com Fallback** ⚠️