Skip to content

Commit

Permalink
TIME
Browse files Browse the repository at this point in the history
  • Loading branch information
@Villosse
Villosse committed Sep 7, 2024
1 parent 082e49f commit 94925d9
Showing 1 changed file with 59 additions and 63 deletions.
122 changes: 59 additions & 63 deletions content/docs/sample-subject/markdown.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
weight: 500
title: "Comment faire du markdown ?"
description: "Comment les sujets sont écrits ?"
description: "Comment les sujets sont-ils écrits ?"
icon: "fluid_med"
date: "2023-08-26T20:43:23+01:00"
lastmod: "2023-08-26T20:43:23+01:00"
Expand All @@ -14,35 +14,37 @@ katex: true

Le LaTeX c'est bien beau mais si on doit faire tous nos cours comme ça, ça nous prendrait une éternité pour couvrir tous les chapitres :c.

C'est pour ça que les sujets sont écrits en `Markdown`.
Enfin, on écrit un fichier en Markdown et `Hugo` nous permet de le transformer en page `Html` automatiquement.
C'est pour ça que les sujets sont écrits en **Markdown**.
Enfin, on écrit un fichier en Markdown et **Hugo** nous permet de le transformer en page **HTML** automatiquement.

Le `Markdown` est un langage de balisage (un peu comme le `Html`) crée avec comme objectif d'offrir une syntaxe facile à lire et à écrire.
Le **Markdown** est un langage de balisage (un peu comme le **HTML**) crée avec comme objectif d'offrir une syntaxe facile à lire et à écrire.

# Pourquoi faire du Markdown ?

Si vous utilisez **Discord**, vous avez peut-être déjà entendu parler de `Markdown`, sinon vous allez voir que c'est vraiment très simple à prendre en main :)
Si vous utilisez **Discord**, vous avez peut-être déjà entendu parler de **Markdown**, sinon vous allez voir que c'est vraiment très simple à prendre en main :)

Voici un exemple montrant la simplicité du `Markdown` par rapport au `Html` et `LaTex`
Voici un exemple montrant la simplicité du **Markdown** par rapport au **HTML** et **LaTex**

{{< tabs tabTotal="3">}}
{{% tab title="Html" %}}
{{% tab title="HTML" %}}

**Html demo**
**HTML demo**

```html
<p>Ce<b>Mot</b> en gras et celui-là <strong>aussi</strong>.</p>
<p>Ce <b>Mot</b> en gras et celui-là <strong>aussi</strong>.</p>
```

<p>Ce<b>Mot</b> en gras et celui-là <strong>aussi</strong>.</p>
> <p>Ce <b>Mot</b> en gras et celui-là <strong>aussi</strong>.</p>
{{% /tab %}}
{{% tab title="LaTex" %}}

**LaTeX demo**

```latex
$$
Ce \textbf{Mot} en gras et celui-là \textbf{aussi}.
$$
```

{{< katex >}}
Expand All @@ -56,11 +58,11 @@ $$

**MarkDown demo**

```markdown
```
Ce **Mot** en gras et celui-là **aussi**.
```

Ce **Mot** en gras et celui-là **aussi**.
> Ce **Mot** en gras et celui-là **aussi**.
{{% /tab %}}
{{< /tabs >}}
Expand All @@ -69,10 +71,10 @@ Ce **Mot** en gras et celui-là **aussi**.

## Titre

Pour écrire des *titres* comme en `HTML` (`h1`, `h2`, `h3`, ...), pour cela il suffit de mettre :
Pour écrire des *titres* comme en **HTML** (`h1`, `h2`, `h3`, ...), il suffit de mettre :


```md
```
# h1
## h2
### h3
Expand All @@ -81,14 +83,12 @@ Pour écrire des *titres* comme en `HTML` (`h1`, `h2`, `h3`, ...), pour cela il
###### h6
```

Résultat :

# h1
## h2
### h3
#### h4
##### h5
###### h6
> # h1
> ## h2
> ### h3
> #### h4
> ##### h5
> ###### h6
## Style

Expand All @@ -97,27 +97,28 @@ Pour mettre le texte en **Gras**, *Italique*, ~~Barré~~, il suffit d'entourer v
- *Italique* : `*` ou `_`
- ~~Barré~~ : `~~`

```md
**Texte en Gras** __Texte en Gras__
*Texte en Italique* _Texte en Italique_
~~Texte Barré~~

**Lorem *Ipsum* ~~dolor sit~~ amet**
```

**Texte en Gras** __Texte en Gras__

*Texte en Italique* _Texte en Italique_

~~Texte Barré~~
Il est possible de combiner ces styles pour faire : **Lorem *Ipsum* ~~dolor sit~~ amet**
```

Il est possible de combiner ces styles pour faire : **Lorem *Ipsum* ~~dolor sit~~ amet**.
> **Texte en Gras** __Texte en Gras__
>
> *Texte en Italique* _Texte en Italique_
>
> ~~Texte Barré~~
>
> Il est possible de combiner ces styles pour faire : **Lorem *Ipsum* ~~dolor sit~~ amet**.
## Citation (Texte)

Pour faire une citation, il faut faire rajouter le signe `>` devant votre texte.

`> citation`
```md
> citation
```

> C'est véritablement utile puisque c'est joli.
Expand All @@ -131,40 +132,36 @@ Pour cela, il suffit d'entourer son extrait de code avec des `` ` `` ou bien ```

Maintenant, pour présenter du code sur plusieurs lignes, il faudra choisir un `langage` et un bout de code à adapter.

```md
Pour insérer du `Code` sur une seule ligne mais si votre code contient déjà des ` alors, vous pouvez mettre votre ``Code``.
````md
Pour insérer du `Code` sur une seule ligne et que le code contient déjà des ` alors, vous pouvez mettre votre ``Code``.

Pour insérer du code sur plusieurs lignes, vous pouvez faire de cette façon.

\`\`\`python

```python
# Il est maintenant possible d'insérer du code entre ces deux lignes et si un langage est précisé, alors, il y aura une jolie syntaxe :).

def sum(a, b):
return a + b

\`\`\`

```

Pour insérer du `Code` sur une seule ligne mais si votre code contient déjà des `` ` `` alors, vous pouvez mettre votre ``Code``.

```python

# Vous pouvez maintenant insérer du code dans entre ces deux lignes et si vous avez précisé le langage alors, il y aura une jolie syntaxe :).

def sum(a, b):
return a + b
````

```
> Pour insérer du `Code` sur une seule ligne mais si votre code contient déjà des `` ` `` alors, vous pouvez mettre votre ``Code``.
>
> ```python
> # Vous pouvez maintenant insérer du code dans entre ces deux lignes et si vous avez précisé le langage alors, il y aura une jolie syntaxe :).
>
> def sum(a, b):
> return a + b
> ```
## Annotation
Une annotation en markdown se fait de la manière suivante `[^n]` juste après un mot en remplaçant *n* par un nombre.
Une annotation en `Markdown` se fait de la manière suivante `[^n]` juste après un mot en remplaçant *n* par un nombre.
Ensuite, pour activer l'annotation, sur une nouvelle ligne, écrire : `[^n]: Ce qu'il faut marquer ici` et hugo se chargera de mettre l'annotation en bas de la page.
Ensuite, pour activer l'annotation, sur une nouvelle ligne, écrire : `[^n]: Ce qu'il faut marquer ici` et **Hugo** se chargera de mettre l'annotation en bas de la page.
Voici un joli texte[^1]
> Voici un joli texte[^1]
[^1]: Ceci est un texte d'exemple.
Expand All @@ -180,29 +177,28 @@ Autre Page/document : [Texte à afficher](overview.md)
Section : [Texte à afficher](#cheat-sheet-markdown)
```
Autre site : [Texte à afficher](https://googls.com)

Autre Page/document : [Texte à afficher](overview.md)

Section : [Texte à afficher](#cheat-sheet-markdown)
> Autre site : [Texte à afficher](https://googls.com)
>
> Autre Page/document : [Texte à afficher](overview.md)
>
> Section : [Texte à afficher](#cheat-sheet-markdown)
## Liste
Il existe plusieurs façons de faire une liste (avec ou sans ordre).
- Pour faire une liste **sans** ordre, il suffit de mettre le char `-`, `+`, `*` au début de la ligne et suivi d'un espace pour créer une nouvel item.
- Pour faire une liste **avec** ordre, il suffit de mettre le numéro de l'item comme ceci: `n.` avec n le numéro de votre item.
- Pour faire une liste **sans** ordre, il suffit de mettre le caractère `-`, `+` ou `*` au début de la ligne et suivi d'un espace pour créer une nouvel item.
- Pour faire une liste **avec** ordre, il suffit de mettre le numéro de l'item comme ceci : `n.` avec n le numéro de votre item.
Exemple:
```md
liste sans ordre:

```
Liste sans ordre:
- item 1
* item 2
+ item 3
+ item 4
- item 5
liste avec ordre:
Liste avec ordre:
1. item 1
2. item 2
3. item 3
Expand Down

0 comments on commit 94925d9

Please sign in to comment.