Doxbrix supports a full **docs-as-code** workflow. Instead of (or in addition to) the visual editor, you can author your documentation as local files, keep them...
Doxbrix supports a full **docs-as-code** workflow. Instead of (or in addition to) the visual editor, you can author your documentation as local files, keep them...
Doxbrix supports a full docs-as-code workflow. Instead of (or in addition to) the visual editor, you can author your documentation as local files, keep them in Git alongside your source code, review changes in pull requests, and sync them to your live site with the dxb command-line tool. It's the same product and the same content model — just driven from your terminal.
Why docs-as-code
The content model
The docs-as-code model has two kinds of files:
docs.json— the navigation manifest. It's the source of truth for your spaces, groups, and pages. A page only appears on your site once it's referenced here..mdxfiles — one per page, each with YAML frontmatter (title, description) and a body of Doxbrix blocks.
A .doxbrix/config.json links the folder to a cloud project. A typical layout:
my-docs/
├─ .doxbrix/
│ └─ config.json # links this folder to a cloud project (projectId, basePath)
└─ docs/ # the base path
├─ docs.json # navigation manifest
├─ get-started/
│ ├─ introduction.mdx
│ └─ quickstart.mdx
└─ api-reference/
└─ authentication.mdxdocs.json. The CLI keeps files and docs.json in sync for you — see Create pages & spaces.The workflow
Install the CLI and set up a token.
Run dxb init to scaffold a new docs-as-code project (or convert an existing tree with --from).
Create pages with dxb new page and edit the .mdx files.
Run dxb dev for a live local preview as you write.
Run dxb lint to catch broken links, bad frontmatter, and orphan pages.
Use dxb status and dxb diff to see what would change, and commit to Git.
Run dxb push --publish — or let CI do it on merge.
App and code stay in sync
Docs-as-code and the visual editor are two views of the same content. Local edits are sent up with dxb push, and dxb status shows what's changed. To keep app edits and a Git repo reconciled automatically in both directions, connect Git sync — a writer can use the editor while an engineer edits MDX in the same project.
Git integration
Connect your repository so publishing happens automatically:
- Connect GitHub or GitLab to your project for two-way sync.
- See Sync & conflicts for how concurrent app and Git edits are reconciled.
AI tools
- The MCP server exposes Doxbrix to MCP-compatible AI clients.
- A skill + MCP setup lets coding agents like Claude author and validate Doxbrix docs correctly.