Connecting a Git repository turns Doxbrix into a Git-backed documentation system. Your `.mdx` files and `docs.json` live in your repo, and the integration keeps...
Connecting a Git repository turns Doxbrix into a Git-backed documentation system. Your `.mdx` files and `docs.json` live in your repo, and the integration keeps...
Connecting a Git repository turns Doxbrix into a Git-backed documentation system. Your .mdx files and docs.json live in your repo, and the integration keeps Git and the app in sync both ways: push to the repo and it's live on your site; edit in the app and it commits back. Writers and engineers share one source of truth.
What the integration gives you
Connect in the app
In your project, go to Settings → Project → Git Sync.
Connect your GitHub or GitLab account so Doxbrix can access the repository.
Select the repository, the tracked branch (e.g. main), and the docs subfolder in the repo (e.g. docs/).
Connect from the CLI
dxb git connect \
--provider github \
--repo acme/product \
--branch main \
--base-path docs| Flag | Description |
|---|---|
| `--provider` | `github`, `gitlab`, `github_enterprise`, or `gitlab_self_managed` (default `github`). |
| `--repo <owner/name>` | The repository to connect (required). |
| `--branch <branch>` | The tracked branch (default `main`). |
| `--base-path <dir>` | The docs subfolder in the repo. |
| `--account <id>` | A connected Git account id (preferred over a token). |
| `--git-token <token>` | A provider PAT/OAuth token (if not using `--account`). |
| `--host <url>` | Host for Enterprise / self-managed providers. |
Check the connection any time with dxb git status.
How sync works after connecting
- Git → site — pushing docs to the tracked branch syncs them to Doxbrix and updates your live site.
- App → Git — edits made in the visual editor are committed back to your repo, attributed to the author, so Git stays the source of truth.
See Sync & conflicts for how simultaneous edits are reconciled.
Monorepos
Docs often live alongside code. Point --base-path at the docs subdirectory; only changes under that path trigger doc syncs:
dxb git connect --repo acme/platform --base-path apps/docs/docsCI-based publishing (alternative)
If you'd rather control publishing yourself, skip Git Sync and run dxb push --publish from CI with a token. See Publish from GitHub.
Disconnecting
Disconnect from Settings → Project → Git Sync. Your content remains in both Doxbrix and your repo — disconnecting only stops the sync.