All docs
On this page

Quickstart

Connect a repository, add a config file, and publish your first entry.

Before you start

TODO — prerequisites. At minimum: what kind of GitHub account is required, whether the repository must be public, and whether an existing content directory is expected.

Connect your repository

  1. TODO — describe what happens at app.kobun.io on first visit.
  2. TODO — the GitHub authorisation step. Name the permissions requested and why.
  3. TODO — choosing a repository and a branch.

Add a config file

TODO — the landing page states that Kobun reads .kobun.json or .kobun.yml from the repository root. Confirm both are supported, and confirm the root is the only location searched.

Publish your first entry

  1. TODO — opening the editor for a collection.
  2. TODO — what autosaving a draft does, and where the draft lives before publish.
  3. TODO — what publishing commits, and to which branch.