Overview
Two-way sync between Docsio and any GitHub repo. Edit in Docsio, edit in your IDE, or both. Included during the trial and with your site subscription.
Connect a repository to maintain documentation in Docsio and GitHub. You choose the repository, branch, optional folder and initial sync direction.
Two ways to work
- Edit in Docsio. Changes stay in the draft until you publish. Publishing sends eligible content changes to the connected repository.
- Edit in GitHub. Push to the configured branch to bring eligible changes into Docsio and trigger a rebuild.
For a branch that requires pull requests, Docsio can use a sync branch and open a PR. Review and merge it in GitHub to land the changes on the target branch. The settings panel shows the PR when one is open.
Before connecting
Decide which side should supply the initial content. Pull from GitHub if it already contains the documentation you want. Push from Docsio if the Docsio draft is the starting point. Keep a backup when both sides contain work you need.
Sync covers documentation, supported images and selected configuration files. It does not export the entire hosting application or synchronize every file in your repository.