Skip to content

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Jieiku committed Aug 24, 2024
1 parent 559e2c1 commit 9dbbae6
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 12 deletions.
28 changes: 16 additions & 12 deletions content/overview-images/index.fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,11 @@ Cet article couvre les **shortcodes imgswap et img**. Les images peuvent égalem

# img Shortcode

- src est le chemin et le nom de fichier de l'image. (obligatoire)
- class définit une classe pour l'image. (facultatif)
- alt définit la note alt pour l'image.
- src est le chemin et le nom de fichier de l'image par défaut. (obligatoire)
- class définit une classe pour l'image.
- alt définit la note alt de l'image.
- caption définit le texte de la légende sous l'image.
- link définit un lien hypertexte pour l'image.
- w est la largeur de l'image.
- h est la hauteur de l'image.

Expand All @@ -34,23 +36,23 @@ Cours optionnels:

## Utilisation (même chemin)
```rs
{{/* img(src="ferris-happy.svg" alt="Ferris est heureux") */}}
{{/* img(src="ferris-happy.svg" class="ci" alt="Ferris est heureux" caption="Ferris" link="https://www.rust-lang.org/") */}}
```
**Sortir**
**Output**
```html
{{ img(src="ferris-happy.svg" alt="Ferris est heureux") }}
{{ img(src="ferris-happy.svg" class="ci" alt="Ferris est heureux" caption="Ferris" link="https://www.rust-lang.org/") }}
```
{{ img(src="ferris-happy.svg" alt="Ferris est heureux") }}
{{ img(src="ferris-happy.svg" class="ci" alt="Ferris est heureux" caption="Ferris" link="https://www.rust-lang.org/") }}

## Utilisation (chemin relatif ./)
```rs
{{/* img(src="./img/ferris-gesture.svg" alt="Ferris dit bonjour") */}}
{{/* img(src="./img/ferris-gesture.svg" alt="Ferris dit bonjour" caption="Ferris" link="https://www.rust-lang.org/") */}}
```
**Sortir**
**Output**
```html
{{ img(src="./img/ferris-gesture.svg" alt="Ferris dit bonjour") }}
{{ img(src="./img/ferris-gesture.svg" alt="Ferris dit bonjour" caption="Ferris" link="https://www.rust-lang.org/") }}
```
{{ img(src="./img/ferris-gesture.svg" alt="Ferris dit bonjour") }}
{{ img(src="./img/ferris-gesture.svg" alt="Ferris dit bonjour" caption="Ferris" link="https://www.rust-lang.org/") }}

## Utilisation (chemin racine /)
```rs
Expand All @@ -77,8 +79,10 @@ Lorsque vous passez votre souris sur l'image, l'image à comparer s'affiche.

- main_src est le chemin et le nom de fichier de l'image par défaut. (obligatoire)
- swap_src est le chemin et le nom de fichier de l'image d'échange. (obligatoire)
- class définit une classe pour l'image. (facultatif)
- class définit une classe pour l'image.
- alt définit la note alt pour l'image.
- caption définit le texte de la légende sous l'image.
- link sets a hyperlink for the image.
- w est la largeur de l'image.
- h est la hauteur de l'image.

Expand Down
2 changes: 2 additions & 0 deletions content/overview-images/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ This post covers the **imgswap and img shortcodes**. Images can also be embedded
- src is the path and filename of the image. (mandatory)
- class sets a class for the image.
- alt sets the alt note for the image.
- caption sets the caption text below the image.
- link sets a hyperlink for the image.
- w is the width of the image.
- h is the height of the image.
Expand Down Expand Up @@ -80,6 +81,7 @@ When you hover your mouse over the image it will display the image to compare.
- swap_src is the path and filename for the swap image. (mandatory)
- class sets a class for the image.
- alt sets the alt note for the image.
- caption sets the caption text below the image.
- link sets a hyperlink for the image.
- w is the width of the image.
- h is the height of the image.
Expand Down

0 comments on commit 9dbbae6

Please sign in to comment.