GitHub Sync
Your docs site, in your repo.
Connect any GitHub repo with one click. Edits in Docsio commit to your branch when you publish. Pushes to your branch rebuild your site automatically. Two-way sync, zero CI to maintain.
[docsio] add streaming API page
docsio[bot] · just nowdeployed
[docsio] update install steps
docsio[bot] · 12 min ago
fix typo in webhook example
chris · 1 hr agogit → docsio
[docsio] initial sync from Docsio
docsio[bot] · 2 days ago
docs/api/streaming.md · just changed
Triggered build
Push detected → build → deploy → live in 47s
Pick the workflow that fits the moment.
Most docs teams have two kinds of contributors: writers who want a visual editor, and engineers who want to live in their IDE. Docsio is one of the few tools that makes both groups happy — without forcing one into the other's workflow.
Editors keep using the Docsio editor. The AI agent stays available. Engineers edit the markdown in VS Code, push, and the site rebuilds. Both directions sync. Nobody has to switch tools.
Capabilities
Everything two-way GitHub sync should do.
One-click connect
Install the Docsio GitHub App on any repo. Pick the org, repo, branch, and optional subdirectory. No GitHub Actions, no CI scripts to maintain — Docsio is the build pipeline.
Two-way sync at publish boundaries
Edits in the Docsio editor stay in draft until you click Publish. Publishing commits the changed files (and only the changed files) to your branch as a single atomic commit, then rebuilds and deploys.
Pushes to your branch rebuild automatically
Anyone with write access to your repo can edit a markdown page in their IDE, push, and watch the docs site rebuild within ~60 seconds. No manual deploy step.
Editor + AI agent stay fully enabled
Unlike GitBook's locked-when-synced model, the Docsio editor and AI agent keep working. Use whichever interface fits the moment — Docsio for visual edits and AI prompts, git for code-style PRs.
Only your content commits — nothing else
Your markdown pages, sidebar metadata, uploaded images, and a small config file. That's it. The rendering engine and any Docsio internals stay on our side, so your repo stays clean — only files you author.
Conflicts can't lose your work
If a teammate pushes to git while you have unpublished editor edits, Docsio snapshots your draft to your version history before applying the pull. One-click restore from the editor banner — no data loss possible.
Setup
Three clicks, no YAML.
Open your project's settings → GitHub tab
Click Connect GitHub. You'll be sent to GitHub to install the Docsio Docs Sync app on the repos you choose.
Pick the repository, branch, and (optional) subdirectory
If your repo is dedicated to docs, leave the subdirectory off — files commit at the root. If it's mixed with app code, point at docs/ or content/ to keep things tidy.
Pick the initial sync direction
GitHub → Docsio if the repo already has markdown docs you want to render. Docsio → GitHub if the repo is empty (or new) and you want Docsio to seed it. After that, it's automatic both ways.
FAQ
Common questions.
Does this work on the free plan?
Yes. GitHub sync is on every plan, including free. The compute cost shows up under your normal monthly publish quota — connecting GitHub doesn't add a separate limit.
Will Docsio commit my whole project to the repo?
No. Only your docs content and uploaded assets cross the boundary: markdown pages, sidebar category metadata, images you uploaded for pages, plus a small docsio.json config file. The rendering engine and any internal Docsio state stay on our side and never touch your repo.
Do I need to set up a GitHub Action or CI?
No. Docsio is the build pipeline. Pushing to your configured branch fires a webhook, Docsio pulls the changes, runs the build in a Vercel sandbox, and deploys. No GitHub Actions yaml, no Vercel project to set up — it's already wired.
What happens if two people edit the same page at the same time?
Last write wins per file, but no edits are lost: when an inbound git push arrives, Docsio snapshots the current Docsio draft to your version history before applying the pull. Your in-progress draft stays one click away to restore from the editor.
Does pushing to GitHub from my IDE replace the Docsio editor?
Only if you want it to. The Docsio editor and AI agent keep working when sync is on. Most teams use a mix: editors who don't write code use the Docsio UI, engineers use git, and both directions sync automatically.
What about a repo that's totally empty?
Docsio handles that. Pick Docsio → GitHub on the first sync — Docsio creates the initial commit (and the main branch) with your current site content as the seed.
How is this different from GitBook's Git Sync?
Same flow on the surface — pick a repo, pick a direction, sync runs both ways. The differences: Docsio doesn't lock the editor when sync is on, the repo only contains your content (not site scaffolding), and there's no separate Pro tier for this — it's free.
Can I disconnect later?
Yes, from the GitHub tab. Disconnecting only clears the Docsio link — your repo and the GitHub App install on github.com stay exactly where they are. You can remove the app from GitHub yourself any time.
Ship your docs from anywhere.
Connect a GitHub repo, edit in the tool that fits the moment, and trust both sides to stay in sync. Free on every plan.