Skip to content

Compléter le MkDocs

  • Tous les fichiers Markdown tels que "index.md" vont dans le dossier docs/.
  • Le fichier index.md est la page d'accueil par défaut.
  • les fichier mardows sont créer de cette manière nano fichier.md

  • la structure de votre MkDocs ce gère dan sle ficheir mkdocs.yml Voici la structure

    mon-wiki/
    ├── docs/           # Tous les fichiers Markdown sont ici
    │   ├── index.md    # Page d'accueil du site
    │   ├── tuto1.md    # Un exemple de tutoriel
    │   └── sous-dossier/ 
    │       └── tuto2.md # Un fichier Markdown dans un sous-dossier
    ├── mkdocs.yml      # Fichier de configuration du site
    └── site/           # Dossier généré après `mkdocs build`
    

Ajouter tes documents Markdown

Créer ou copier tes fichiers Markdown : Place tes fichiers .md dans le dossier docs/. Exemple :

cd mon-wiki/docs nano tuto1.md

Contenu du fichier tuto1.md :

# Tuto 1 : Installer MkDocs Voici un tutoriel détaillé pour installer MkDocs. - Étape 1 : ... - Étape 2 : ...

Compléter un dossier Markdown

Titre 1 = #
Titre 2 = ##
Titre 3 = ###
Titre 4 = ####
Italique = *texte*
Gras = **texte**
==surligner==
~~barré~~
- liste de point
`texte de code`
[texte apparent](lien web ou fichier docs)

Organiser tes documents dans des sous-dossiers

Si tu as beaucoup de fichiers, tu peux les regrouper dans des sous-dossiers. Par exemple :

site_name: "Mon Wiki"
nav:
  - Accueil: index.md
  - Tutoriels:
      - "Installation MkDocs": tuto1.md
      - "Utilisation avancée": tuto2.md
  - Linux:
      - "Commandes de base": sous-dossier/linux.md
      - "Tuto avancé": sous-dossier/tuto_avancé.md