Overview

Quick start: publish a documentation site with Docsbook

Before you start#

You need all of the following:

  • A current version of Chrome, Firefox, Safari or Edge.
  • One source, and only one: a GitHub repository containing at least one .md file, a public website URL, or two sentences describing what you sell.
  • A way to sign in at step 3: a GitHub account, a Google account, an Apple ID, or an email address where you can receive a one-time code.

You do not need a credit card, a build pipeline, or an account before step 3.

1
Step 1 — Generate a draft
  1. Open docsbook.io/start.
  2. Paste your source into the single field: a website URL, a GitHub repository link, or a sentence about your product. Docsbook works out which it is — there is no type to pick.
  3. Wait while Docsbook reads the source. Each step names what it read and what it found.

Expected result: a draft site opens on its own admin panel, with the page count, the source it came from, and every section for branding, layout and SEO. No account has been created yet.

2
Step 2 — Open the draft and check it
  1. Press Open on the admin panel, or click the preview itself.
  2. Browse the generated pages as a real documentation site — header, sidebar tree, outline, breadcrumbs and prev/next all work.
  3. Use Assistant in the panel to change wording or ask about the site. In the message box, interactive mode opens the site with the chat beside it and every block clickable.

Expected result: you have read the draft and know whether it describes your product correctly. A draft from a website or an idea lives in your browser only until you publish it.

3
Step 3 — Sign in to publish
  1. Press Publish this site on the panel's front page, or the blue button in the toolbar on the documentation itself. It reads Publish if you have changed nothing yet, Save changes if you have, and Claim ownership if you arrived through a claim link — all three do the same thing.
  2. Choose a sign-in method: GitHub, Google, Apple, or email with a one-time code.
  3. Complete the sign-in flow.

Expected result: the draft becomes a live Docsbook project with a public address, a search index and analytics. Nothing you wrote is re-done.

If your site came from a GitHub repository and you signed in with Google, Apple or email, Docsbook asks you to authorise GitHub access as well — it reads the repository files through that authorisation.

4
Step 4 — Open the published site
  1. Open the address Docsbook shows you. It follows the pattern below.
docsbook.io/{owner}/{repo}
  1. Use the search box in the header, or press Cmd+K (Ctrl+K on Windows and Linux), and search for a phrase from one of your pages.

Expected result: the page loads at a public URL, search returns your phrase, and the site is readable without signing in.

What you have now#

You have a published documentation site: a public URL, full-text search, a sitemap.xml, llms.txt for AI agents, and analytics recording page views from the first visitor. A site built from a GitHub repository re-checks the repository when it is visited, so pushing to GitHub updates the pages with no build step.

Next steps#

Publish your first site

Paste a repository, a website URL, or a sentence about your product, and read the draft before you sign in.

Updated

Was this page helpful?