Titre

Nouvelles flavours lors de la migration de Outline vers mkdocs#

• ajouter un commentaire qui ne figure pas dans le site : // commentaire
• ajout d’une icône propre à la page :
  • choisir l’icône dans https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/#search (par exemple, :material-cat:)
  • rajouter au début du document : // _CONFIG icon: material/cat
• rajouter un titre à un bloc : ajouter !!! "Ceci est un titre" en première ligne du bloc

Syntaxe#

Titres#

Le titre du document est le <h1> implicite.

Seuls les # du document sont dans la table des matières.

Créer les titres avec #, ##, ###, etc.

Commentaires#

Toute ligne qui commence par // est supprimée lors de la mise en prod.

Si ça commence par // _CONFIG, ça permet de renseigner des méta-données pour le fichier.

Frontmatter, il faut respecter la syntaxe sans rajouter d’accents pour les clefs :

Affichage#

Liste de texte en :

• gras
• italique
• gras et italique
• barré
• gras et barré
• italique et barré
• gras et italique et barré
• surligné
• code

Emojis#

Emojis : (commencer à écrire avec un :)

Font awesome ( https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/#search ) :

Combinaison de touches de clavier#

https://facelessuser.github.io/pymdown-extensions/extensions/keys/#action-keys

Keys: Ctrl+Alt+Suppr , Maj+F

Liens vers :#

• un autre fichier : index
• https://example.com
• website
• Mail: user@example.com
• Tel: +330123456789
• heading : Titre 4

Listes#

• Lorem ipsum dolor sit amet, consectetur adipiscing elit
• Vestibulum convallis sit amet nisi a tincidunt
  • In hac habitasse platea dictumst
  • In scelerisque nibh non dolor mollis congue sed et metus
  • Praesent sed risus massa

• Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque

  1. Lorem ipsum dolor sit amet, consectetur adipiscing elit
     • In hac habitasse platea dictumst

• Nulla et rhoncus turpis. Mauris ultricies elementum leo. Duis efficitur accumsan nibh eu mattis. Vivamus tempus velit eros, porttitor placerat nibh lacinia sed. Aenean in finibus diam.
  • Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis.
  • Nam vulputate tincidunt fringilla.
    • Nullam dignissim ultrices urna non auctor.

1. Vivamus id mi enim. Integer id turpis sapien. Ut condimentum lobortis sagittis. Aliquam purus tellus, faucibus eget urna at, iaculis venenatis nulla. Vivamus a pharetra leo.

   1. Vivamus venenatis porttitor tortor sit amet rutrum. Pellentesque aliquet quam enim, eu volutpat urna rutrum a. Nam vehicula nunc mauris, a ultricies libero efficitur sed.

   2. Morbi eget dapibus felis. Vivamus venenatis porttitor tortor sit amet rutrum. Pellentesque aliquet quam enim, eu volutpat urna rutrum a.

      1. Mauris dictum mi lacus
      2. Ut sit amet placerat ante
      3. Suspendisse ac eros arcu

Tableau#

Citation#

Citation

Diagrammes Mermaid et snippets de code#

flowchart TD
    A[Begin] -->|Action| B(Intermediate)
    B --> C{Decision}
    C -->|One| D[1]
    C -->|Two| E[2]

#!/bin/bash
# This script prints a greeting message
echo "Hello, World!"

# Using APT

sudo apt install foo

# using dnf
sudo dnf install foo

Latex#

$$ cosx=k=0∑∞​(2k)!(−1)k​x2k

ewline xn+yn=zn $$

Text can be deleted and replacement text added. This can also be combined into onea single operation. Highlighting is also possible and comments can be added inline.

Admonitions#

Footnotes#

Include une balise¹ dans le corps du paragraphe apparaîtra comme une node en exposant qui se dévoile au survol de la souris. Tu peux aussi utiliser une balise nommée² pour mieux la décrire !

Quiz#

C’est possible de faire des quiz !

Le quiz est dans un template pour l’avoir toujours sous la main !

La doc est ici https://ewels.github.io/mkdocs-quiz/