Getting Started
Pages et navigation
Chaque fichier Markdown devient une page.
L’ordre dans la sidebar est contrôlé par :
nav_order: 1
Hiérarchie :
---
title: Guides
has_children: true
---
Sous-page :
---
title: Installation
parent: Guides
---
Layouts
Par défaut, toutes les pages utilisent layout: default.
Tu peux forcer :
layout: default
Ou créer tes propres layouts dans :
_layouts/
Table of Contents
Insertion automatique :
{:toc}
Exemple :
Titres
# H1
## H2
### H3
Les titres H2+ alimentent automatiquement le TOC.
Liens internes
Relatifs :
[API](api)
Absolus :
[API](/docs/api)
Code
Bloc simple :
ls -la
Avec langage :
{
"name": "example"
}
Highlight automatique.
Callouts
Note :
Texte informatif.
Warning :
Attention.
Important :
Contenu critique.
Tableaux
| Champ | Description |
|---|---|
| id | identifiant |
| name | libellé |
Images et assets
Placer les fichiers dans :
/assets/images
Utilisation :
Tout ce qui est dans /assets est servi statiquement.
Variables globales
Définies dans _config.yml :
title: Example Docs
Utilisation :
EduDocs
Includes (réutilisation)
Créer :
_includes/snippet.md
Insérer :
{: .note }
Ceci est un include réutilisable (/_includes/snippet.md).
Utile pour :
- avertissements globaux
- blocs répétés
- headers custom
Listes
Non ordonnée :
- A
- B
Ordonnée :
1. A
2. B
Citations
> Ceci est une citation.
HTML inline
Autorisé :
<div class="custom">
Custom HTML
</div>
Front-matter complet typique
---
title: API
nav_order: 3
parent: Docs
has_children: false
layout: default
---
Organisation recommandée
docs/
index.md
guides/
reference/
api.md
Chaque sous-dossier devient une section.
Résumé
Fonctionnalités natives :
- Sidebar hiérarchique
- Layouts
- TOC automatique
- Code highlighting
- Callouts
- Assets statiques
- Variables globales
- Includes
- Markdown étendu
- HTML inline
Aucune extension requise.
Fin.