Quick Start — 3 Minutes
Create a documentation site from GitHub in 3 simple steps.
Step 1: Sign In with GitHub#
- Open docsbook.io
- Click the "Create my docs site" button
- Click "Sign in with GitHub"
- Allow Docsbook access to your GitHub profile
✅ Docsbook will only get access to your public repositories and profile name.
Step 2: Choose a Repository#
After signing in you'll see a list of your public repositories.
- Find the repository with documentation
- Click on it
- Docsbook will create a workspace
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
Done! 🎉#
Your documentation site is live. It automatically syncs with GitHub.
What's Next?#
- Update documentation in GitHub → it appears on the site automatically
- Set up your custom domain (Premium)
- Enable translation to other languages (Premium)
- Hide the "Powered by Docsbook" badge (Premium)
Additional guides: