Travailler avec VitePress
L’objectif est simple : vous permettre d’écrire visuellement le Markdown courant tout en évitant de détériorer les syntaxes VitePress plus avancées.
Ce qui reste éditable visuellement
Les paragraphes, titres, listes, tableaux, liens, images et blocs de code simples sont ouverts normalement dans l’éditeur. Vous pouvez donc travailler sur l’essentiel du document sans regarder la source.
Ce qui est conservé en source
Certaines constructions contiennent plus d’informations que l’éditeur visuel ne peut en représenter correctement. Elles sont alors protégées et conservées telles quelles, notamment :
- le frontmatter YAML ;
- les containers et GitHub alerts ;
- les groupes de code ;
- les métadonnées et directives Shiki ;
- les imports de snippets avec
<<<; - les inclusions Markdown ;
[[toc]]et les ancres personnalisées ;- les formules mathématiques et notes de bas de page ;
- le HTML brut ;
- les composants Vue, interpolations et blocs SFC.
Exemple avec un bloc de code
Ce bloc reste entièrement éditable :
```typescript
const message = 'Bonjour'
```En revanche, si vous ajoutez un titre de fichier, des numéros de lignes ou une directive [!code ...], l’éditeur préfère conserver la source exacte. Vous pouvez toujours la modifier dans le mode Markdown.
La règle la plus simple
Utilisez l’éditeur visuel pour écrire et structurer le contenu courant. Passez en mode source lorsqu’une syntaxe VitePress avancée doit être modifiée précisément.
TIP
Le rendu final dépend de la configuration VitePress de votre application, en particulier pour les composants Vue et les plugins Markdown ajoutés par votre projet.