Getting Started with CubeDocs

CubeDocs is a modern, crowd-sourced documentation platform that lives on GitHub Pages.

Why CubeDocs?

Traditional documentation site generators are great for reading, but difficult for contributing. CubeDocs changes that by providing an in-browser IDE for everyone.

Installation

To add CubeDocs to your project:

1. Create a docs/ folder in your repository.
2. Add a GitHub Action to deploy the platform.
3. Configure your Auth Proxy.

Core Philosophy

We believe that documentation should be as easy to edit as it is to read. No more cloning, no more local environment setup—just login, edit, and PR.