Aller au contenu

MKdocs#

Installation#

Github#

Une fois déployé il faut penser à: - Aller dans settings - Aller sur pages - Choisir le fork utilisé pour pusher les fichiers


Configuration#

Les rubriques sont entre simple quote et les liens relatifs

nav:
  - Home: index.md
  - Aide :
      - 'MkDocs' : aide/mkdocs.md
      - 'Qemu' :
        - 'Paramètres': ./aide/parametres.md


Bases#

Listes#

Pour créer une liste, il faut séparer le contenu de la liste du titre qui l'annonce.

Pour le moment je n'ai pas réussi à intégrer dans une balise details.

Exemple: Exemple de code: 
Ma liste:  
- element 1  
- element 2

Rendu: Ma liste:
  • element 1
  • element 2



Avancé#

Alerter (admonition)#

Types:

  • note
  • abstract
  • info
  • tip
  • success
  • question
  • warning
  • failure
  • danger
  • bug
  • example
  • quote


Une ligne#

Le contenu est obligatoirement entre ""

!!! note "une note"

une note


Blocks#

!!! note

    Le texte de ma note sur plusieurs lignes

avec un titre

Le texte de ma note sur plusieurs lignes

!!! note "avec un titre"

    Le texte de ma note sur plusieurs lignes

Note

Le texte de ma note sur plusieurs lignes

Version expandable (avec le + ouvert par défaut) 

???+ note

Note

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.



Exemples#

Example

Note

Abstract

Info

Tip

Success

Question

Warning

Failure

Danger

Bug


Quote