Frequently Asked Questions (FAQ)

General Questions#

Q: What is Docsbook?

A: Docsbook transforms your GitHub documentation into a beautiful site in 5 seconds. Just connect your GitHub repository and you're done!

Q: Do I need to pay to get started?

A: No! The free plan includes 1 repository, GitHub sync, and beautiful design. Premium ($29 one-time) adds a custom domain, translations, and more.

Q: What kind of repository do I need?

A: Any public GitHub repository with markdown files. This can include:

README.md
Project documentation
Instructions
API reference
Any markdown files

Q: Are private GitHub repositories supported?

A: Currently only public ones. Private repos are planned for the future.

Q: Do I need to configure anything in GitHub?

A: No! Just connect your account via OAuth. Docsbook will get access to your public repos.

Usage#

Q: How do I update my documentation?

A: Just update the files in GitHub — the site syncs automatically.

Edit the .md file
Commit to GitHub
Open the Docsbook site
See the updates!

Q: How quickly does documentation update?

A: Very quickly, on your next visit:

You visit the site
Docsbook checks GitHub for new content
Shows the latest version

Typically: instantly.

Q: Why hasn't my site updated?

A: Check:

Is the commit actually in GitHub? (Check on github.com)
Did you refresh the browser? (Ctrl+F5)
Has 1-2 minutes passed?
Is the file extension .md?

Q: What folder structure should I use?

A: Any! We recommend:

repo/
├── README.md
├── docs/
│   ├── getting-started.md
│   ├── api/
│   └── guides/

But any other structure works too.

Q: Can I use .markdown instead of .md?

A: Yes, both extensions work.

Q: Do links between files work?

A: Yes! Use:

[Link](/docs/path/to/file)
[Link to folder](/docs/folder/file)

They are automatically converted to proper URLs.

Q: What about images?

A: Put them in a folder (e.g., docs/images/) and reference them:

![Description](https://raw.githubusercontent.com/docsbook-io/docs/main/images/screenshot.png)

PNG, JPG, GIF, WebP are supported.

Q: Can I use HTML?

A: Markdown supports HTML, so yes:

<div>Regular HTML</div>

But we recommend plain markdown.

Access & Security#

Q: Who can see my documentation?

A: Everyone on the internet! Your site is fully public.

People without a GitHub account
Search engine bots (Google, Bing)
Anyone

This is expected — you want everyone to see your documentation.

Q: How does this relate to a private GitHub repo?

A: Even if a GitHub repo is private, documentation on Docsbook is open. That's the magic! 😊

(Private repos are not yet supported)

Q: Is my documentation secure?

A: Yes, HTTPS (SSL) and Vercel CDN are used.

Q: Can someone edit my documentation through Docsbook?

A: No, that's not possible. Editing can only be done in GitHub.

Q: Who sees the Float Widget (control buttons)?

A: Only you, when logged in. Other people see only the documentation.

Premium#

Q: What is Premium?

A: A one-time subscription ($29) with additional features:

Unlimited repositories
Custom domain
Hide "Powered by Docsbook"
Automatic translation

Q: How much does Premium cost?

A: $29 USD one-time, for life. The first 100 customers paid $19.

Q: How do I pay?

A: Click "Upgrade to Premium" in the Float Widget → enter your card in the Stripe form.

Accepted: Visa, Mastercard, AmEx, Apple Pay, Google Pay.

Q: Is payment secure?

A: Yes, 100%. Payments are processed by Stripe (a world leader). Docsbook never sees your card number.

Q: Is there a refund?

A: Yes, full refund within the first 30 days. Contact support@docsbook.io.

Q: Will the price increase?

A: No, $29 is the permanent price. You pay once.

Q: Can I buy Premium for multiple workspaces?

A: Yes, but you need to buy it for each one separately. It's affordable ($29 per workspace).

Q: Are there discounts for organizations?

A: Contact support@docsbook.io for special arrangements.

Domains#

Q: How do I use my own domain?

A: Premium feature. Guide: Custom Domain Setup

TL;DR:

Enter domain in Settings
Update DNS (add CNAME)
Wait 30 minutes
Done!

Q: Which is better: root domain or subdomain?

A: We recommend a subdomain:

✅ docs.example.com (recommended)
✅ example.com (also works)
✅ guide.example.com (multiple can be used)

Q: Do I need SSL (HTTPS)?

A: Docsbook sets it up automatically via Let's Encrypt. Free and no action required on your part.

Q: How long does DNS propagation take?

A: Usually 15-30 minutes, up to 48 hours maximum.

Translations#

Q: How do I translate documentation?

A: Premium feature. Guide: Translations

TL;DR:

Open Settings
Select languages
Click Save
Docsbook translates in minutes

Q: What languages are supported?

A: 100+, including:

Spanish, French, German
Russian, Chinese, Japanese
Arabic, Korean, Thai
And many more

Q: How good is AI translation?

A: Good for technical documentation. May need editing for idioms and cultural references.

Q: Will translations update when I update docs?

A: Yes, automatically.

Q: Can I edit translations?

A: Yes, you can download and edit manually. Contact support@docsbook.io.

Support & Issues#

Q: How do I contact support?

A: Email: support@docsbook.io

Premium customers get priority.

Q: Is there Docsbook documentation?

A: Yes, you're reading it! See the other sections.

Q: What should I do if something is broken?

A: Write to support@docsbook.io with a description of the issue.

Q: Is there a status page?

A: Coming soon. Follow on twitter.com/docsbook.

Technical Questions#

Q: What is Docsbook built with?

A: Next.js, React, Vercel, Stripe, GitHub API.

Q: Where is data stored?

A: On Vercel (servers in the US and other countries) and Neon Postgres.

Q: What markdown parser is used?

A: Remark + Rehype. GitHub Flavored Markdown (GFM) is supported.

Q: Does site search work?

A: Built-in search is coming soon. For now use browser search (Ctrl+F).

Q: Is there a dark theme?

A: Coming soon. Currently only the light theme is available.

Q: How many concurrent visitors can it handle?

A: Vercel scales automatically. Don't worry about load.

Legal#

Q: Is there a Terms of Service?

A: Yes, see Terms (coming soon).

Q: What about a Privacy Policy?

A: Yes, see Privacy (coming soon).

Q: What if I violate the rules?

A: We'll reach out to you. Usually we give a chance to fix things.

Don't see an answer to your question?#

Write to support@docsbook.io — we're happy to help! 😊

Next: