Docsy / docs

DOCSY BY APPGRAM

Your documentation. Your source. Your infrastructure.

Documentation built for humans and coding agents. Write Markdown, ingest OpenAPI and native SDK reference, and configure it in YAML. Own the editable source and host it wherever you choose.

Native SDK samples

Twenty languages imported from actual native documentation-generator output. Fixture sources, generator versions, commands, and SHA-256 hashes are checked in. These teaching libraries are not published SDK packages.

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.

10 symbols · docc

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.

7 symbols · dartdoc

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.

13 symbols · typedoc

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.

6 symbols · jsdoc

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.

5 symbols · sphinx

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.

19 symbols · rustdoc

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.

10 symbols · docfx

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.

7 symbols · docfx

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.

7 symbols · docfx

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.

8 symbols · dokka

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.

12 symbols · javadoc

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.

6 symbols · scaladoc

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.

4 symbols · godoc

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.

6 symbols · doxygen

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.

5 symbols · doxygen

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.

4 symbols · doxygen

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.

5 symbols · phpdoc

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.

5 symbols · yard

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.

4 symbols · exdoc

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.

3 symbols · ldoc

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.

4 symbols · typedoc-lite

Guides

Guides and tutorials written in Markdown and configured in YAML.

TUTORIAL

draw.io diagrams

Embed SVG and PNG architecture diagrams, expand them to inspect details, and offer editable source downloads.

GET STARTED

Get started with Docsy

Build documentation for humans and coding agents, generate a project, and understand its editable source.

WORKFLOW

Work with coding agents

Read Markdown exports, guide your coding agent with project instructions, and validate documentation changes.

WORKFLOW

Maintain documentation automatically

Turn API and code changes into validated draft PRs with updated articles, corrected examples, and migration notes.

TUTORIAL

Configure Docsy with YAML

Understand how docsy.config.yaml controls product copy, navigation, visual tokens, content, and access.

TUTORIAL

Write authored documentation

Add Markdown guides and articles beside generated API and SDK reference pages.

AUTHORING

Authors, reviews and edit links

Credit authors and contributors, link to GitHub edits, and optionally record coding-agent provenance without claiming an automatic quality score.

TUTORIAL

Ingest an OpenAPI document

Turn a local or remote OpenAPI source into grouped, searchable API reference pages.

AUTHORING

Rich article components

Write callouts, steps, synchronized tabs, accordions, code groups, and reusable snippets in Markdown.

AUTHORING

Write native MDX articles

Mix Markdown with themed JSX components, keep Mintlify MDX sources, and explicitly opt into trusted custom components.

AGENTS

Full-text search and agent JSON API

Search complete content and retrieve permission-aware JSON or Markdown for coding agents.

CONFIGURATION

Versions and localization

Configure versioned articles, translated navigation, language fallbacks, and version-specific ingestion.

RELIABILITY

Validate documentation content

Catch ingestion failures, invalid API examples, broken links, and invalid article components before publishing.

INGESTION

Ingest SDK documentation

Import 16 native generator formats covering 20 source languages into consistent SDK reference pages.

EXAMPLES

Explore 20 native SDK samples

Inspect actual generator output, source fixtures, tool versions, reproduction commands, and provenance hashes.

CUSTOMIZATION

Customize the default UI

Change branding and theme tokens in YAML, then edit the source-owned Astro interface when needed.

TUTORIAL

Protect documentation by tier

Configure server-side documentation permissions using ordered YAML rules.

DEPLOYMENT

Deploy to GitHub Pages

Publish an open-mode Docsy site from GitHub Actions with the correct origin and base path.

DEPLOYMENT

Self-host Docsy

Deploy static documentation or run locked mode on Node, Bun, or Docker.

REFERENCE

CLI reference

Generate projects, validate configuration, build releases, and run production previews.

REFERENCE

Upgrade a customized site

Record template provenance and compare upstream fixes without overwriting your source or content.

MIGRATION

Migrate from Mintlify

Preserve native MDX and supported components from a local Mintlify export, with navigation, assets, and redirects.

REFERENCE

Compatibility evidence

Reproduce real-library imports and understand exactly what the tests do and do not establish.

REFERENCE

Docsy license

Understand what ELv2 permits, what it prohibits, and how it applies to self-hosting and contributions.

API reference

Generated from the OpenAPI source configured in docsy.config.yaml.

—