Start here

Getting started

On this page

After this page your client can edit their own site in Siteshare, while the site stays in your repository and on your host.

What you need

  • A website in a GitHub repository. Astro, Next.js, Nuxt, SvelteKit, Eleventy, Hugo, Vite and plain HTML all work.
  • A host that publishes the site when main changes, such as Cloudflare Pages, Netlify or Vercel.
  • A Siteshare account. Signing in works with a code by email, or with GitHub.

1. Connect GitHub

On Home, choose Connect GitHub. GitHub asks where to install the Siteshare app: on your own account or an organisation, on all repositories or the ones you choose. Siteshare only ever works in the repositories you give it.

2. Add a site

Choose Add a site and pick the repository. Siteshare then checks the site:

  • it recognises what kind of site it is, and fetches, installs and starts it in its own sandbox;
  • it builds the site once, the way your host would;
  • it looks for your host, and for automations in the repository that could touch the client’s draft.

What it finds shows on the site’s page under Before you invite a client. Nothing there stops you; it tells you what to look at.

3. Check the settings

Siteshare proposes settings for the site: how to start and build it, and which parts are protected. Choose Looks right, or change them and let Siteshare save them as admin.json in your repository. You can also write admin.json yourself. See admin.json.

4. The sign-in page on your site

Your client signs in from their own site, at /edit. Siteshare offers to add that small page to your repository in one commit, and asks first. It only leads to the sign-in screen; it holds no secret.

5. Invite your client

On the site’s page, under Settings › Access, choose Invite clients, add their email address and pick their step: what they may change. See What your clients can change and Inviting clients and access. They get an email, sign in, and see their own site with a chat next to it.

When something goes wrong

  • The site’s page shows why a site cannot start, in plain words, and what to change.
  • The site’s Log shows who did what, and when.
  • Reply to any email from Siteshare, or write to us.
View as plain text, for an AI assistant.