Versidify

Introduction

Versidify turns a folder of MDX files into a fast, navigable documentation site.

Versidify is a documentation engine. You keep your content as MDX in version control; Versidify renders it as a static site with navigation, a table of contents, and syntax-highlighted code.

Why it exists

Hosted documentation platforms work well until you want to change something they did not anticipate: a layout, an auth rule, where the content lives. Versidify keeps the authoring experience close to those platforms while leaving the deployment on infrastructure you control.

How it fits together

Content flows through three stages:

  1. Source: a ContentSource returns pages and site configuration. The filesystem implementation reads content/.
  2. Navigation: docs.json declares grouping and ordering. Pages absent from it are reported rather than silently dropped.
  3. Render: MDX is compiled per request with GitHub-flavoured markdown, heading anchors, and dual-theme code highlighting.

Each stage is independent. Swapping the source does not change rendering.

The hosted platform

Beyond the engine, Versidify runs the parts a team needs to actually publish: organisations and members, your own domain with certificates handled for you, and a dashboard to write in.

Documentation can live in a Git repository instead, in which case the repository is authoritative and a push publishes. A pull request gets a preview URL to read before it is merged, with broken links and anchors reported alongside it.

Sites are public by default and can sit behind a password. Search is hybrid, keyword fused with embeddings that run in the same cluster as the content, and answers cite the pages they came from and refuse when the documentation does not cover the question.

Was this page helpful?