Visão geral

Quick Start — 3 Minutes

No account required to start. Create a documentation site in 3 simple steps.

Step 1: Start generating — no sign-in required#

  1. Open docsbook.io and click "Create website"
  2. Pick a source: a website URL to scan, a GitHub repo to link, or just describe your idea in text
  3. For website or idea sources, Docsbook generates a full draft site in under a minute — no account needed yet
  4. If you picked GitHub, you'll be taken straight to a live preview of your repo's docs

Note: For website/idea sources, your draft lives in your browser only until you publish. It opens as a real documentation site — header, sidebar tree, outline, breadcrumbs and prev/next — so you can browse every generated page and adjust branding, layout and SEO in the settings panel before deciding to sign in.

Step 2: Sign in to publish#

Once you're happy with the draft, click Publish changes in the settings panel.

  1. Choose a sign-in method — GitHub, Google, Apple, or email (one-time code)
  2. Complete the sign-in flow for your chosen method
  3. Your draft is automatically saved as a live Docsbook workspace — no re-work needed

Note: Docsbook uses GitHub to read repository files. If your site came from a GitHub repo and you sign in with Google, Apple, or email, you'll be prompted to authorize GitHub access.

Step 3: View Your Site#

Your documentation is already available at:

docsbook.io/{your-name}/{repo}

Example:

  • GitHub: github.com/alice/my-project
  • Docsbook: docsbook.io/alice/my-project

If you started from a website or an idea, Docsbook hosts the generated site for you under its own repository — the URL follows the same docsbook.io/{owner}/{repo} pattern.

Done! 🎉#

Your documentation site is live. GitHub-sourced sites automatically sync with the linked repository.

What's Next?#

  • Update documentation in GitHub → it appears on the site automatically
  • Set up your custom domain (PRO)
  • Enable translation to other languages (PRO)
  • Hide the "Powered by Docsbook" badge (PRO+)

Additional guides:

Updated