Docsio
DocumentationGuides
GitHub Sync

What gets committed

Sync documentation and assets without exposing template infrastructure.

GitHub sync uses a content allowlist. Only supported paths cross between Docsio and the configured repository folder.

Included content

PathContent
docs/**/*.md and docs/**/*.mdxDocumentation pages, including nested folders
docs/**/meta.jsonCurrent navigation metadata
public/img/**Current image assets
docsio.jsonShared supported configuration
README.md and .docsioignoreRepository guidance

Supported older-site category files and images under static/img/ are also recognized. Keep the conventions already used by that project.

What stays in Docsio

Template source, application components, dependencies, build outputs and environment files are not part of content sync. Named-version archives are not included in the content allowlist either. The connected repository is not a full backup or export of the hosting application.

Repository folders

If you choose a subdirectory, the supported paths are relative to it. For example, a configured content/ folder can contain content/docs/quickstart.mdx and content/public/img/setup.png.

Check the configured repository, branch and folder before syncing. Never put credentials in a documentation page or public asset.

Keep exploring

Connect a repo · How sync works
Need a hand? Talk to the Docsio teamClear docs. Happier readers.

On this page