Une documentation que les développeurs lisent vraiment
L'IA crée une documentation avec la structure attendue par les développeurs : sommaire latéral, recherche instantanée, sélecteur de version, code copiable.
Ce qui est inclus
Sommaire latéral
Navigation imbriquée et repliable, synchronisée avec la structure de fichiers de votre documentation.
Recherche (en-tête dédié)
Un champ de recherche proéminent dans l'en-tête ; connectez votre propre outil via des liens ou des intégrations.
Pages par version
Publiez des pages par version (ex. /v1, /v2) et reliez-les entre elles.
Blocs de code avec copie
Code avec coloration syntaxique dans plus de 200 langages, avec copie en un clic et prise en charge des onglets.
À qui s'adresse cette solution
Documentation d'API
API publiques nécessitant une référence des endpoints, des guides d'authentification et des exemples de code SDK.
Projets open source
Projets hébergés sur GitHub avec des guides d'installation, d'utilisation et de contribution.
Bases de connaissances internes
Manuels d'entreprise, documents d'intégration et runbooks derrière un SSO.
Modèles pour ce cas d'usage
Plateforme no-code
Une page de destination moderne au style glassmorphism pour les outils no-code, les intégrations API, les automatisations de flux de travail et les portails de développeurs.
Page d'atterrissage SaaS
Lancez votre produit SaaS avec une page premium comprenant une section héro épurée, une grille de fonctionnalités interactive, un tableau de tarification et une preuve sociale axée sur la conversion.
Questions fréquentes
Puis-je rédiger la documentation en Markdown ?
Oui — prise en charge native de Markdown avec frontmatter pour le titre, la description et la position dans le sommaire.
La recherche fonctionne-t-elle hors ligne ?
La recherche native intégrée fonctionne sans dépendances externes. Une mise à niveau Algolia est disponible pour un trafic plus élevé.
Puis-je héberger plusieurs versions ?
Oui — chaque version est une arborescence de contenu distincte ; les utilisateurs basculent via le menu déroulant de la barre supérieure.
Y a-t-il un mode sombre ?
Oui — synchronisation automatique avec les préférences système de l'utilisateur ; remplacement manuel disponible.
Puis-je publier des pages de référence d'API avec des exemples de code ?
Oui — les modèles de documentation prennent en charge les tableaux de paramètres, les exemples de réponse et les extraits de code à onglets pour plusieurs SDK.