Syntaxe & tips

Voici les principales commandes de syntaxe sous mkdocs avec le theme matérial, toute ces tips ont été trouvé sur cette page0 github.

---

1. Liste des extension Markdown

Voici la liste de nos extension en markdown a implémenter dans votre fichier mkdocs.yml afin de garentir le bon fonctionnement de toutes les commandes de styntaxes.

markdown_extensions:
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tabbed
  - attr_list
  - md_in_html
  - pymdownx.superfences
  - pymdownx.highlight
  - pymdownx.tilde
  - pymdownx.tasklist:
      custom_checkbox: true
      clickable_checkbox: true

---

2. Les commandes principales

Syntaxe

Gras :

**texte**

Italique :

*texte*

Barré :

~~texte~~

Souligner :

<ins> 
texte 
</ins>

Mise en forme

Code inline :

`code`

Citation

Ceci est une sitation :

> Texte

Bloc de code :

"```"
ton code ici
"```"

indice : _indice

<sub>
indice
</sub>

Exposant : ^Exposant

<sup>
exposant 
</sup>

"#" Titre Principale

"##" Sous titre 1

"###" Sous titre 2

"####" Sous titre 3

---

Outils

Liens externe google

[texte du lien](http://ceciestunlien)

Images

![texte de l'image](lien vers l'image)

Voici le moyen d'ordonner vos liens :

Context Lien relatif
Dans un fichier .md sur la même branche /assets/images/electrocat.png
Dans un fichier .md sur une autre branche   /../main/assets/images/electrocat.png
Dans les problèmes, les demandes de tirage et les commentaires du dépôt ../blob/main/assets/images/electrocat.png?raw=true
Dans un fichier .md dans un autre dépôt /../../../../github/docs/blob/main/assets/images/electrocat.png
Dans les problèmes, les demandes de tirage et les commentaires d’un autre dépôt ../../../github/docs/blob/main/assets/images/electrocat.png?raw=true

Listes

-Premier élément 
-Deuxième element
-Troisième élément

1. James Madison
2. James Monroe
3. John Quincy Adams

Anotation

(1)

1. Ceci est une annotation

<div class="annotate" markdown>

Phrase avant l'annotation (1) phrase après l'annotation

</div>
1. Contenue de l'annotation

Il est possible de modifier l'icone de l'annotation en ajoutant l'icone dans le mkdocs.yml

theme :
  logo : logo.png
  icon : material/chevron-right-circle
  name : material
  language : fr
  palette:
    - scheme: default
      primary: red
      accent: white
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: red
      accent: white
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

Il est possbile de différencier les annotation et d'en mettre plusieurs à la suite, il suffit de changer le numéro associé.

Liste de taches

(1)

1. mettre un "x" entre les crochet marque la tâche comme faite

- [x] #739
- [ ] https://github.com/octo-org/octo-repo/issues/740
- [ ] Add delight to the experience when all tasks are complete :tada:

• TACHE ACOMPLIE
• TACHE A ACOMPLIRE

Emoji

(1)

:EMOJICODE:

1. Liste complète des emoji utilisables en markdown ici.

Surligner

Il est possible sur surligner des lignes de codes dans un bloc de code, il suffit d'ajouter

python hl_lines="0"

Juste après "```" la ou 0 représente le numéro de ligne.

Dans mon exemple 
la 4 ème ligne
seras surligner
celle la

---