Blume est un framework de documentation open-source axé sur Markdown, conçu pour générer des sites prêts pour la production sans configuration, avec des capacités d'IA intégrées et un support interactif pour les références API.
Fonction du produit et positionnement officiel
Blume simplifie la création de sites de documentation en permettant aux utilisateurs de publier du contenu directement à partir de fichiers Markdown. Il automatise les fonctionnalités essentielles telles que la navigation, le SEO et la recherche, permettant aux développeurs de se concentrer sur le contenu plutôt que sur la maintenance de l'infrastructure.
La plateforme est conçue tant pour les lecteurs humains que pour les agents machines, offrant un support natif pour les formats compatibles avec les LLM comme llms.txt et les serveurs MCP. Elle fournit une suite complète de composants et un ensemble d'outils CLI pour gérer l'intégralité du cycle de vie de la documentation.
Cas d’usage étayés par les sources officielles
Créez des sites de documentation complets, consultables et interactifs pour les projets logiciels et les outils de développement.
Générez des pages de référence API interactives à partir de spécifications OpenAPI ou AsyncAPI avec des environnements de test intégrés.
Le parcours documenté, lorsqu’il est disponible
Exécutez la commande npx blume init pour échafauder un nouveau projet de documentation avec les fichiers de configuration nécessaires.
Placez des fichiers Markdown ou MDX dans le dossier du projet pour générer automatiquement la navigation du site et la structure des pages.
Blume est conçu pour combler le fossé entre la documentation lisible par l'homme et les connaissances accessibles par les machines. En générant automatiquement des index lisibles par machine et en fournissant un accès Markdown brut à chaque URL, l'outil permet aux modèles d'IA et aux agents de codage d'interpréter et d'utiliser avec précision le corpus de documentation.
Vérifications à effectuer avec vos contenus et votre flux de travail
Sources vérifiées et date de la vérification
Réponses fondées sur la fiche produit dont les sources ont été vérifiées
Non, Blume est conçu pour fonctionner sans configuration. Un simple dossier de fichiers Markdown sert de projet complet, et la navigation est déduite automatiquement de la structure de vos fichiers.
Oui, Blume prend en charge plusieurs sources de contenu. Vous pouvez configurer le framework pour extraire du contenu de dépôts distants, de plateformes CMS ou de backends personnalisés via la configuration des sources de contenu.
Blume prend en charge les références API interactives en acceptant les spécifications OpenAPI ou AsyncAPI. Il les transforme en pages de documentation incluant des schémas et un environnement de test en direct.
Oui, Blume prend en charge l'internationalisation pour jusqu'à 36 langues, incluant un support complet pour les langues s'écrivant de droite à gauche, garantissant que votre documentation puisse atteindre une base d'utilisateurs mondiale.
Blume comprend une interface de ligne de commande intégrée qui automatise les tâches de maintenance telles que la validation des liens, l'audit des performances SEO, l'évaluation de la qualité de la documentation et la gestion des mises à jour de traduction.
