DOCSY BY APPGRAM
Votre documentation. Votre code. Votre infrastructure.
Un portail soigné pour vos lecteurs, des exports Markdown pour vos agents, et du code que vous contrôlez. Rédigez des guides, importez vos références API et SDK, puis hébergez le tout vous-même.
Exemples de SDK
Vingt langages importés à partir de sorties réelles de générateurs de documentation. Sources, versions, commandes et empreintes sont incluses. Ces bibliothèques de test ne sont pas des paquets publiés.
Swift · DocC
Real Swift DocC output from the checked-in swift fixture source. Generated artifacts, commands, versions, and SHA-256 hashes are recorded under sources/native. This is a teaching library, not a published SDK.
Dart · Dartdoc
Real dart doc output from the checked-in dart fixture source. Generated artifacts, commands, versions, and SHA-256 hashes are recorded under sources/native. This is a teaching library, not a published SDK.
TypeScript · TypeDoc
Real TypeDoc output from the checked-in typescript fixture source. Generated artifacts, commands, versions, and SHA-256 hashes are recorded under sources/native. This is a teaching library, not a published SDK.
JavaScript · JSDoc
Real JSDoc output from the checked-in javascript fixture source. Generated artifacts, commands, versions, and SHA-256 hashes are recorded under sources/native. This is a teaching library, not a published SDK.
Python · Sphinx
Real Sphinx JSON builder output from the checked-in python fixture source. Generated artifacts, commands, versions, and SHA-256 hashes are recorded under sources/native. This is a teaching library, not a published SDK.
Rust · rustdoc
Real stable rustdoc HTML output from the checked-in rust fixture source. Generated artifacts, commands, versions, and SHA-256 hashes are recorded under sources/native. This is a teaching library, not a published SDK.
C# · DocFX
Real DocFX assembly and compiler XML output from the checked-in csharp fixture source. Generated artifacts, commands, versions, and SHA-256 hashes are recorded under sources/native. This is a teaching library, not a published SDK.
F# · DocFX
Real DocFX assembly and compiler XML (declarations are C# when F# syntax is absent) output from the checked-in fsharp fixture source. Generated artifacts, commands, versions, and SHA-256 hashes are recorded under sources/native. This is a teaching library, not a published SDK.
Visual Basic · DocFX
Real DocFX assembly and compiler XML output from the checked-in visualbasic fixture source. Generated artifacts, commands, versions, and SHA-256 hashes are recorded under sources/native. This is a teaching library, not a published SDK.
Kotlin · Dokka
Real Dokka HTML output from the checked-in kotlin fixture source. Generated artifacts, commands, versions, and SHA-256 hashes are recorded under sources/native. This is a teaching library, not a published SDK.
Java · Javadoc
Real Javadoc HTML output from the checked-in java fixture source. Generated artifacts, commands, versions, and SHA-256 hashes are recorded under sources/native. This is a teaching library, not a published SDK.
Scala · Scaladoc
Real Scaladoc 2 HTML output from the checked-in scala fixture source. Generated artifacts, commands, versions, and SHA-256 hashes are recorded under sources/native. This is a teaching library, not a published SDK.
Go · go doc
Real go doc -all output from the checked-in go fixture source. Generated artifacts, commands, versions, and SHA-256 hashes are recorded under sources/native. This is a teaching library, not a published SDK.
C · Doxygen
Real Doxygen XML output from the checked-in c fixture source. Generated artifacts, commands, versions, and SHA-256 hashes are recorded under sources/native. This is a teaching library, not a published SDK.
C++ · Doxygen
Real Doxygen XML output from the checked-in cpp fixture source. Generated artifacts, commands, versions, and SHA-256 hashes are recorded under sources/native. This is a teaching library, not a published SDK.
Objective-C · Doxygen
Real Doxygen XML output from the checked-in objectivec fixture source. Generated artifacts, commands, versions, and SHA-256 hashes are recorded under sources/native. This is a teaching library, not a published SDK.
PHP · phpDocumentor
Real phpDocumentor XML output from the checked-in php fixture source. Generated artifacts, commands, versions, and SHA-256 hashes are recorded under sources/native. This is a teaching library, not a published SDK.
Ruby · YARD
Real YARD HTML output from the checked-in ruby fixture source. Generated artifacts, commands, versions, and SHA-256 hashes are recorded under sources/native. This is a teaching library, not a published SDK.
Elixir · ExDoc
Real ExDoc HTML output from the checked-in elixir fixture source. Generated artifacts, commands, versions, and SHA-256 hashes are recorded under sources/native. This is a teaching library, not a published SDK.
Lua · LDoc
Real LDoc HTML output from the checked-in lua fixture source. Generated artifacts, commands, versions, and SHA-256 hashes are recorded under sources/native. This is a teaching library, not a published SDK.
Portable metadata · manual example
An explicitly hand-authored compact-format example for custom converters. Not a native generator fixture and not counted among the 20 native languages.
Guides
Guides et tutoriels rédigés en Markdown et configurés en YAML.
draw.io diagrams
Embed SVG and PNG architecture diagrams, expand them to inspect details, and offer editable source downloads.
PREMIERS PASBien démarrer avec Docsy
Créez un portail pour les humains et les agents, générez un projet et prenez le contrôle de son code.
WORKFLOWWork with coding agents
Read Markdown exports, guide your coding agent with project instructions, and validate documentation changes.
WORKFLOWMaintain documentation automatically
Turn API and code changes into validated draft PRs with updated articles, corrected examples, and migration notes.
TUTORIALConfigure Docsy with YAML
Understand how docsy.config.yaml controls product copy, navigation, visual tokens, content, and access.
TUTORIALWrite authored documentation
Add Markdown guides and articles beside generated API and SDK reference pages.
AUTHORINGAuthors, reviews and edit links
Credit authors and contributors, link to GitHub edits, and optionally record coding-agent provenance without claiming an automatic quality score.
TUTORIALIngest an OpenAPI document
Turn a local or remote OpenAPI source into grouped, searchable API reference pages.
RÉDACTIONDes articles plus expressifs
Ajoutez des encadrés, des étapes, des onglets, des blocs de code et des extraits réutilisables en Markdown.
AUTHORINGWrite native MDX articles
Mix Markdown with themed JSX components, keep Mintlify MDX sources, and explicitly opt into trusted custom components.
AGENTSFull-text search and agent JSON API
Search complete content and retrieve permission-aware JSON or Markdown for coding agents.
CONFIGURATIONVersions et langues
Testez les sélecteurs, les variantes d’un article et le repli vers la langue par défaut.
RELIABILITYValidate documentation content
Catch ingestion failures, invalid API examples, broken links, and invalid article components before publishing.
INGESTIONIngest SDK documentation
Import 16 native generator formats covering 20 source languages into consistent SDK reference pages.
EXAMPLESExplore 20 native SDK samples
Inspect actual generator output, source fixtures, tool versions, reproduction commands, and provenance hashes.
CUSTOMIZATIONCustomize the default UI
Change branding and theme tokens in YAML, then edit the source-owned Astro interface when needed.
TUTORIALProtect documentation by tier
Configure server-side documentation permissions using ordered YAML rules.
DEPLOYMENTDeploy to GitHub Pages
Publish an open-mode Docsy site from GitHub Actions with the correct origin and base path.
DEPLOYMENTSelf-host Docsy
Deploy static documentation or run locked mode on Node, Bun, or Docker.
REFERENCECLI reference
Generate projects, validate configuration, build releases, and run production previews.
REFERENCEUpgrade a customized site
Record template provenance and compare upstream fixes without overwriting your source or content.
MIGRATIONMigrate from Mintlify
Preserve native MDX and supported components from a local Mintlify export, with navigation, assets, and redirects.
REFERENCECompatibility evidence
Reproduce real-library imports and understand exactly what the tests do and do not establish.
REFERENCEDocsy license
Understand what ELv2 permits, what it prohibits, and how it applies to self-hosting and contributions.
Référence API
Generated from the OpenAPI source configured in docsy.config.yaml.
Posts · OpenAPI sample
Public JSONPlaceholder requests, generated from a local OpenAPI file. Copy GET, POST, PUT, PATCH, and DELETE examples. Writes are simulated and are not persisted.
Comments · OpenAPI sample
A public GET request with an optional postId filter. The query value, curl command, and response example come from the OpenAPI source.