Skip to content

Docleus Documentation

Docleus is an open-source, self-hosted documentation platform for teams that want to write together, review changes before they go live, and own their deployment.

The product is built around a small plugin-first core. Organizations contain spaces, spaces contain pages, and a published site serves an immutable snapshot of one or more spaces. The block tree is the source of truth, while Markdown remains a first-class import and export format.

Status: Docleus is pre-1.0. Public APIs, configuration, and deployment details may change before the first stable release.

Start here

Core concepts

ConceptMeaning
OrganizationThe top-level collaboration boundary for people, spaces, and sites.
SpaceA documentation project with its own page tree, members, plugins, and site.
PageA block-based document inside a space.
RevisionAn immutable commit in a space's history.
BranchA line of revisions. Every space has main; change requests use additional branches.
PublicationAn immutable build of a site, created from a revision of main.

What is available in 0.1.0

  • Block editing with headings, lists, task lists, quotes, code, tables, images, thematic breaks, and Mermaid diagrams.
  • Real-time collaborative editing.
  • Change requests with three-way merges, configurable approvals, and plugin checks.
  • Password accounts, invitations, organization and space roles, and OIDC login.
  • Immutable site publications, publication history, rollback, custom domains, site search, and llms.txt output.
  • SQLite or PostgreSQL storage, local files or S3-compatible blob storage, and a Docker-based distribution.
  • Runtime plugin installation and per-organization or per-space enablement.

Git Sync, collections, visitor-aware publishing, AI question answering, and MCP integration are planned for later releases. The plugin SDK is experimental until 1.0.

License

Docleus is released under the MIT License.