un format de documentation plaintext

1. Markdown What?
2. Markdown, un format simple
3. Markdown au quotidien

• Spécification CommonMark / Fiche de révision Markdown courte (EN)
• Fiche de révision Markdown longue (EN)
• Présentation (FR, Ionos)
• Markdown, du HTML simple (FR, Openclassroom)

1. Exemple
2. Traitement du markdown
3. Markdown VS Word
4. Markdown VS HTML

Langage de balisage léger créé par John Gruber en 2004, avec l'aide de Aaron Swartz avec le but d'offrir une syntaxe facile à lire et à écrire

• .md, .markdown
• Type MIME
• text/markdown
• version initiale le 19 mars 2004

-- https://fr.wikipedia.org/wiki/Markdown

1. Titres et mise en forme de texte
2. Images et liens
3. Code
4. Liste, liste imbriquée et liste énumérée
5. Liste, entrées multilignes
6. Blockquote/citations

text italique, text gras, italique et gras

# Markdown, un format simple

## Titres et mise en forme de texte

_text italique_, **text gras**, _**italique et gras**_

code markdown	rendu
[Fiche de révision](https://commonmark.org/help/)	Fiche de révision

Un exemple de `inline code` au sein d'une phrase (touche AltGr+7).

```
exemple de bloc de code
multiligne!
```

Un exemple de inline code au sein d'une phrase (touche AltGr+7).

exemple de bloc de code
multiligne!

- LFSR feed avec différentes données
- LFSR parallélisable
  - temps de traversé réduit
    1. meilleur utilisation du silicium
    2. réduction des couts

• LFSR feed avec différentes données
• LFSR parallélisable
  • temps de traversé réduit
    1. meilleur utilisation du silicium
    2. réduction des couts

- LFSR feed avec différentes données
  LFSR parallélisable
- générateur d'aléatoire
  - pseudo-aléatoire
    (methode de Von Neumann, etc.)

• LFSR feed avec différentes données LFSR parallélisable
• générateur d'aléatoire
  • pseudo-aléatoire (methode de Von Neumann, etc.)

> Simplicity is prerequisite for reliability.
> — Edsger Dijkstra

Simplicity is prerequisite for reliability. — Edsger Dijkstra

---

1. Pièges habituels
2. Solution habituelle
3. Pièges habituels
4. Solution habituelle
5. Comment faire X?
6. Ce que l'on ne peux pas faire avec Markdown
7. VSCode
8. Gitlab / Github -- Comment faire une bonne documentation?
9. Liens et Ressources
10. Pour aller plus loin

Salez.
Poivrez.

Salez. Poivrez.

Salez.

Poivrez.

Salez.

Poivrez.

-Salez
-Poivrez

-Salez -Poivrez

- Salez
- Poivrez

• Salez
• Poivrez

• Inclure les symbole _ et * plusieurs fois?
  1. Les placer dans groupe de inline-code: `_`, `*`
  2. Utiliser backslash: \_text\_, \*\*a\*\* -> _text_, **a**
• Utiliser des backslashs \ ?
  1. Les placer dans groupe de inline-code: `\` -> \
  2. Doubler le backslash: \\ -> \
• Appliquer du formattage sur du code?
  • _`code`_ -> code
  • **`code`** -> code
  • **_`code`_** -> code

• Appliquer du formattage à l'intérieur d'un bloque de code :-/ -> A la place utiliser des commentaires
• Indenter une liste de plus d'un niveau à la fois -> Envisager d'utiliser un bloque de code

• Download (.zip -> 64bit)

• Extension Markdown All in One

  • Markdown All in One: Create Table of Content
  • Format Document

• Live Preview Alternatives

  • markdownlivepreview

• *.md
• README.md
• Single-page documentation (versus "Click Insanity")

• Syntax alternatives (titre, italique, gras, images, liens, listes ...)

• Fonctionnalités supplémentaires

  • Text barré (~~a~~ -> a), Tableaux Markdown, Listes énumérées
  • Coloration de code ( ```sh)
  • Markdown+HTML / Markdown+Latex

• Autres cas d'usage

  • Slides/Présentations avec Marp
  • Écriture de rapports (Pandoc+LaTex)

• Spécification CommonMark / Fiche de révision Markdown courte (EN)
• Fiche de révision Markdown longue (EN)
• Présentation (FR, Ionos)
• Markdown, du HTML simple (FR, Openclassroom)