vdoc

vdoc hosts documentation for many projects, at many versions, in one place. A project builds its documentation, uploads the result as a ZIP, and vdoc serves it at /<project>/<version>/ with a landing page, a version picker and its own header around it.

It builds nothing itself and does not care what did. Sphinx, Docusaurus, Doxygen and a hand-written index.html all publish the same way: a directory of files with an index.html in it.

🌍 See it in action

The voraus robotik GmbH software documentation runs on vdoc: docs.vorausrobotik.com

What it does

• Keeps every version. An upload never overwrites an earlier one, and latest follows the newest. → Publishing documentation
• Looks like your organization. Title, logo, colors, footer links and search are configuration, not a fork. → Plugins
• Answers machines as well as people. /llms.txt, /sitemap.xml and /robots.txt are generated from what is actually published. → Agent and crawler discovery
• Stays consistent across generators. vdoc renders the chrome, the framed site hides its own. → The frame contract

Where to start

Getting started has vdoc running and a first version published in a few minutes. From there, Configuration is the reference for everything an instance can be told.

If you are building a documentation site that vdoc will serve, @voraus/docusaurus-theme implements the frame contract already.