writedocs

Pour les équipes logicielles qui ont besoin d’un espace public pour leurs guides produit et leurs références d’API, WriteDocs transforme un dépôt de documentation GitHub en portail de documentation hébergé. Rédigez les pages en Markdown ou en MDX, organisez-les en sections de navigation et de produits, puis prévisualisez les modifications en local avec l’interface en ligne de commande WriteDocs. La publication des mises à jour sur GitHub déploie automatiquement le portail. Les équipes peuvent personnaliser l’apparence et la structure du portail, utiliser des modèles de pages et des composants réutilisables, et générer des pages de référence d’API à partir de fichiers OpenAPI. Les pages d’API comprennent un espace de test interactif où les développeurs peuvent envoyer des requêtes et consulter les réponses. WriteDocs peut convenir aux équipes à l’aise avec une approche de documentation gérée comme du code et qui souhaitent maintenir leurs guides produit et leur documentation destinée aux développeurs aux côtés de leur code.

Avertissement : WebCatalog n’est ni affilié, ni associé, ni autorisé, ni approuvé par writedocs, et n’entretient aucun lien officiel avec cette entité. Tous les noms de produits, logos et marques sont la propriété de leurs détenteurs respectifs.