Introduction · Documentation Specistry

Specistry transforme vos contrats OpenAPI et vos pages Markdown en portail développeur auto-hébergé, entièrement généré à l’avance.

Vous fournissez trois éléments : un contrat OpenAPI (facultatif), un dossier de pages Markdown (facultatif) et un fichier specistry.config.ts. La CLI les valide, construit un artefact immuable, et le lecteur Node le sert depuis votre propre infrastructure.

TutorielVotre premier siteInstaller, écrire une page, construire. Dix minutes.7 vidéosTous les tutorielsPages, référence API, médias, SDK, versions, CI.RéférenceComposantsCallout, Steps, Cards, Tabs, CodeGroup.5 modèlesModèlesPartez d’un projet qui fonctionne.

Comment tout s’articule

chaîne de build

openapi.yaml ─┐
docs/*.md    ─┼─▶ specistry validate ─▶ specistry build ─▶ .specistry/artifacts ─▶ lecteur
config.ts    ─┘                         specistry check   (contrôle qualité)

Ce que Specistry ne fait volontairement pas

Exécuter ce que vous écrivez — le contenu est une donnée, jamais du code
Deviner des méthodes SDK que vous n’avez pas déclarées
Faire transiter les requêtes du playground par un serveur
Importer de l’AsyncAPI ou du GraphQL
Fonctionner comme un service hébergé

NoteLa configuration est du code, le contenu est une donnée.

specistry.config.ts est du code de build de confiance : relisez-le comme un script de build. Le corps des pages et les descriptions d’API ne sont jamais exécutés, seulement affichés comme du texte.