GitHub sync
Push markdown, get deployed docs. Pull requests get preview links.
GitHub sync
Connect a repository once, and nobody on your team runs a deploy again:
- Push to your main branch → production deploys automatically, and the deployment timeline shows the commit message, author, and files changed.
- Open a pull request → a preview deployment builds, and a comment with the preview link lands on the PR. Push more commits, get fresh previews.
Connect a repository
Install the GitHub App
In the console under Git Settings, choose Install GitHub App and grant it your docs repository. The app asks for read access to repository contents, metadata, and pull requests, plus write access to issues — the write scope exists solely so it can comment preview links on your pull requests. If the app is already installed on your organization, the console shows it with a one-click Connect to Workspace instead.
Link it to your site
On your site's Git panel, pick the organization, repository, and branch from the dropdowns and choose Connect Repository.
That's the setup
Connecting deploys your branch's current state immediately — no empty state, no first-push ritual. From here, git is your publish button.
What the platform expects
The repository root should be a docs site — docs.json and package.json
at the top level, exactly what fiskil init produces. Repository extras
like LICENSE, .github/, and dotfiles are ignored during deployment.
Behavior details
- Pushes to branches other than the linked one are ignored; so are branch deletions.
- Pull requests from forks never auto-deploy — fork code doesn't get your credentials.
- One deployment runs per site at a time; a push during a running build is picked up by the next push.
fiskil publishkeeps working alongside sync — the deployment timeline labels each deploy's source (github,cli,console).