Introduction
What Bloques is, who it's for, and how it's different.
What is Bloques?
Bloques is an open-source documentation platform. Connect a GitHub repository, edit pages in a browser-based block editor, and publish a documentation site on a subdomain (<slug>.bloques.site) or a custom domain.
Your repository stays the source of truth. Every save in the editor writes a real Git commit to the connected repo, and a push — from the editor or from git push — triggers an automatic deploy. There is no proprietary content store and no markdown toolchain to assemble locally.
Bloques handles hosting, rendering, and theming so the team can focus on the writing. The editing surface looks like a modern document tool; the storage layer is the repo you already use.
Who it's for
Bloques is built for engineering teams shipping public documentation — developer tools, API products, open-source projects — who want a visual editor for the people who write, without giving up the Git workflow the engineers depend on. Technical writers and product managers can draft pages without learning MDX syntax. Engineers still review changes as commits and pull requests.
If the goal is a fully managed editor with no repository, no commits, and no GitHub involvement, look elsewhere. Bloques is opinionated about Git ownership.
How it's different
Git-native
Edits in the browser create real commits on real branches in your repository. The repo is the canonical source — not a mirror, not a cache, not a one-way sync. Move to a different platform later and the content is already where it needs to be.
Open source
The codebase is open. There is no proprietary lock-in on the content format or the rendering pipeline. Self-hosting is not available today, but the foundation for it is in the open.
Browser editor for non-engineers
The block editor lets writers structure pages with draggable blocks — headings, code, callouts, images, tables — without touching MDX syntax directly. Engineers keep reviewing changes as diffs; writers stop filing tickets to fix typos.
When not to use Bloques
Bloques is in early access. A few use cases are not a good fit yet:
- Auto-generated API reference. Bloques does not generate reference pages from an OpenAPI spec or a code schema today. Write reference pages by hand or use a dedicated tool.
- No-GitHub workflows. Every site is backed by a GitHub repository. Other Git providers and repo-less editing are not supported.
- Enterprise auth and compliance. Single sign-on, audit logs, and fine-grained permissions are not built. Sign-in is a magic link sent over email.
Next
Ready to publish a site? See the Quickstart.