L’éditeur web

DocPlatform inclut un éditeur de texte riche basé sur Tiptap (fondé sur ProseMirror) qui affiche le Markdown en temps réel tout en préservant une compatibilité totale avec le format Markdown source. Chaque modification que vous effectuez produit un fichier .md propre — pas de format propriétaire, pas de verrouillage.

Disposition de l’éditeur

┌─────────────────────────────────────────────────────────────┐
│  Sidebar          │  Editor                                 │
│                   │                                         │
│  📁 Getting       │  ┌──────────────────────────────────┐   │
│     Started       │  │ Frontmatter (collapsible)        │   │
│  📁 Guides        │  │ Title: ___________________       │   │
│  📁 API           │  │ Description: ______________      │   │
│    > auth.md      │  │ Tags: [api] [auth]               │   │
│    > endpoints    │  └──────────────────────────────────┘   │
│  📄 changelog     │                                         │
│                   │  Start writing here...                  │
│  ┌────────────┐   │                                         │
│  │ + New Page │   │                                         │
│  └────────────┘   │  ┌──────────────────────────────────┐   │
│                   │  │ Toolbar: B I Link Image Code ... │   │
└───────────────────┴──┴──────────────────────────────────┘   │

Barre latérale

• Arborescence des pages — Liste imbriquée de toutes les pages de l’espace de travail. Glissez pour réorganiser.
• Nouvelle page — Créez une nouvelle page au niveau racine ou imbriquée sous une page existante.
• Raccourci de recherche — Cliquez ou appuyez sur Cmd+K / Ctrl+K pour ouvrir la recherche plein texte.

Formulaire de frontmatter

La section de frontmatter repliable en haut de l’éditeur fournit des champs de formulaire pour les métadonnées de la page :

Les modifications des champs de frontmatter mettent automatiquement à jour le bloc YAML dans le fichier .md.

Barre d’outils

La barre d’outils de mise en forme offre un accès rapide à :

Modes d’écriture

Mode texte riche (par défaut)

L’éditeur affiche le Markdown sous forme de contenu mis en forme. Les titres apparaissent comme des titres, les liens sont cliquables, les blocs de code ont la coloration syntaxique.

Mode Markdown brut

Cliquez sur le bouton </> dans la barre d’outils pour basculer vers l’édition Markdown brute. Cela vous donne une vue en texte brut du fichier avec coloration syntaxique.

Le mode brut est utile pour :

• Ajuster finement la mise en forme Markdown
• Modifier directement le frontmatter YAML
• Coller du contenu provenant d’autres sources
• Utiliser des composants personnalisés (Callout, Tabs, etc.)

Les modifications se synchronisent instantanément entre les modes. Basculez librement sans perdre votre travail.

Sauvegarde automatique

DocPlatform sauvegarde automatiquement votre travail toutes les quelques secondes. Vous verrez un indicateur d’état dans la barre d’outils :

Si la synchronisation git est activée, chaque sauvegarde déclenche un auto-commit. Les commits sont regroupés — des modifications rapides produisent un seul commit avec le format de message : docs: update {page-title}.

Travailler avec le contenu

Images

Glissez-déposez ou collez des images directement dans l’éditeur. Les images sont stockées dans le répertoire d’assets de l’espace de travail et référencées avec des chemins relatifs.

Formats supportés : PNG, JPG, GIF, SVG, WebP.

Tableaux

Insérez des tableaux depuis la barre d’outils. Les tableaux supportent :

• Ajout/suppression de lignes et colonnes
• Bascule de la ligne d’en-tête
• Alignement du texte (gauche, centre, droite)
• Syntaxe de tableau Markdown en mode brut

Blocs de code

Insérez des blocs de code avec la barre d’outils ou en tapant trois backticks (```). Sélectionnez un langage pour la coloration syntaxique — Shiki prend en charge plus de 200 langages.

// Code blocks with syntax highlighting
function greet(name) {
  return `Hello, ${name}!`;
}

Liens internes

Créez des liens vers d’autres pages de votre espace de travail en utilisant des liens Markdown standard :

See the [API Authentication](/fr/docs/reference/api/) guide.

DocPlatform valide les liens internes et la commande doctor signale les références cassées.

Raccourcis clavier

Note : Sous Windows et Linux, remplacez Cmd par Ctrl.

Collaboration en temps réel

Lorsque plusieurs utilisateurs sont actifs dans le même espace de travail, des indicateurs de présence montrent qui est en ligne et quelle page ils consultent. La barre latérale affiche les avatars des utilisateurs à côté des pages en cours d’édition.

DocPlatform ne prend pas en charge l’édition simultanée de la même page par plusieurs utilisateurs. Si deux utilisateurs tentent de sauvegarder des modifications conflictuelles sur la même page, le Content Ledger détecte la collision via le hash de contenu et renvoie une erreur 409 avec les deux versions disponibles pour résolution manuelle.

Astuces

• Glissez les pages dans la barre latérale pour réorganiser la structure de votre documentation
• Composants de la barre d’outils — insérez des callouts, des blocs de code et des tableaux depuis la barre d’outils de l’éditeur
• Collez du texte riche depuis Google Docs, Notion ou Confluence — l’éditeur le convertit en Markdown propre
• Valeurs par défaut du frontmatter — définissez des valeurs par défaut au niveau de l’espace de travail pour published, access et tags afin de réduire la saisie répétitive