Syntaxe Markdown
Titres
Utilisez des titres pour introduire les sections principales. Ils structurent votre documentation et aident les utilisateurs à naviguer dans le contenu.
## Titres
Sous-titres
Utilisez des sous-titres pour diviser davantage les sections. Ils créent une hiérarchie de contenu plus détaillée pour une meilleure lisibilité.
### Sous-titres
Mise en forme du texte
Docus prend en charge la plupart des options de mise en forme Markdown.
| Style | Syntaxe | Résultat |
|---|---|---|
| Gras | **gras** | Gras |
| Italique | *italique* | Italique |
| Barré | ~~barré~~ |
Combinez les styles pour enrichir le texte et mettre en valeur des éléments.
| Style | Syntaxe | Résultat |
|---|---|---|
| Gras Italique | **_gras italique_** | Gras Italique |
| Gras Barré | ~~**gras**~~ | |
| Italique Barré | ~~*italique*~~ |
Liens
Les liens relient différentes parties de votre documentation et des ressources externes, essentiels pour la navigation et les références.
Pour créer un lien, entourez le texte du lien avec des crochets []().
[Nuxt UI](https://ui.nuxt.com/getting-started/installation/nuxt)
Liens internes
Pour lier des pages de votre documentation, utilisez des chemins relatifs à la racine comme /getting-started/installation.
[Installation](/fr/getting-started/installation)
Listes
Organisez des éléments liés dans un format structuré et lisible. Markdown prend en charge les listes non ordonnées, ordonnées et imbriquées pour divers besoins.
Non ordonnée
Utilisez des listes non ordonnées pour des éléments sans ordre particulier. Commencez chaque élément par un symbole -.
- Je suis un élément de liste.
- Je suis un autre élément de liste.
- Je suis le dernier élément de liste.
- Je suis un élément de liste.
- Je suis un autre élément de liste.
- Je suis le dernier élément de liste.
Ordonnée
Utilisez des listes ordonnées lorsque l'ordre des éléments est important, comme des étapes d'un processus. Commencez chaque élément par un numéro.
- Je suis un élément de liste.
- Je suis un autre élément de liste.
- Je suis le dernier élément de liste.
1. Je suis un élément de liste.
2. Je suis un autre élément de liste.
3. Je suis le dernier élément de liste.
Imbriquée
Créez des listes hiérarchiques avec des sous-éléments pour des structures complexes. Indentez les sous-éléments de quatre espaces pour l'imbrication.
- Je suis un élément de liste.
- Je suis un élément de liste imbriqué.
- Je suis un autre élément de liste imbriqué.
- Je suis un autre élément de liste.
- Je suis un élément de liste.
- Je suis un élément de liste imbriqué.
- Je suis un autre élément de liste imbriqué.
- Je suis un autre élément de liste.
Tableaux
Présentez des données structurées en lignes et colonnes. Les tableaux sont idéaux pour comparer des données ou lister des propriétés.
| Prop | Défaut | Type |
|---|---|---|
name | string | |
size | md | string |
color | neutral | string |
| Prop | Défaut | Type |
|---------|-----------|--------------------------|
| `name` | | `string`{lang="ts-type"} |
| `size` | `md` | `string`{lang="ts-type"} |
| `color` | `neutral` | `string`{lang="ts-type"} |
Citations
Mettez en avant des citations, références ou textes importants. Les citations distinguent visuellement le contenu cité.
Une ligne
Les citations sur une seule ligne sont idéales pour des citations courtes et percutantes. Ajoutez un > devant un paragraphe. Idéal pour les citations courtes.
Nuxt UI est une collection de composants Vue, de composables et d'utilitaires construits sur Nuxt UI, orientés structure et layout, conçus comme des blocs de construction pour votre application.
> Nuxt UI est une collection de composants Vue, de composables et d'utilitaires construits sur Nuxt UI, orientés structure et layout, conçus comme des blocs de construction pour votre application.
Multiligne
Les citations multiligne conviennent aux citations plus longues ou pour inclure plusieurs paragraphes dans une seule citation.
Nuxt UI est une collection de composants Vue, de composables et d'utilitaires construits sur Nuxt UI, orientés structure et layout, conçus comme des blocs de construction pour votre application.
Créez de belles applications Vue réactives et accessibles avec Nuxt UI.
> Nuxt UI est une collection de composants Vue, de composables et d'utilitaires construits sur Nuxt UI, orientés structure et layout, conçus comme des blocs de construction pour votre application.
>
> Créez de belles applications Vue réactives et accessibles avec Nuxt UI.