FAQ

3
Last updated 24 days ago

Common questions about GitBook and the new version

Can I use my previous GitBook.com account ?

Yes, you can login using the same credentials you used on legacy.gitbook.com (email/password, Google or GitHub login).

Can I migrate over our GitBook.com content ?

Yes, see the detailed page:

How can I report bugs ?

Bugs should be reported using the messaging widget available from your dashboard or by sending an email to support@gitbook.com. In order to get the best help possible, please provide as much context on how you encountered the bug. Steps to reproduce the issue are even better.

How can I request features ?

If you think a feature is missing or should be improved, head to https://gitbook.canny.io/feature-requests. Search for an existing request for the same feature and upvote it, or create a request. Providing relevant use-cases, or user-stories, with screenshots is the best way to make your feature accepted.

Can I integrate GitBook with my Git hosting service ?

For now, we only support GitHub synchronization. We do not support other git hosting services, like GitLab. The content on GitBook is still always backed-up and versioned. Your content is always available to export, so it is never locked on our platform.

How do I access my GitBook repository ?

We are no longer versioning your books as a Git repository. We have shifted to a GitBook specific versioning system. As a consequence, we no longer offer git hosting services for your books. If you need your documentation to be accessible as a Git repository, you can always use the GitHub synchronization.

Does GitBook exports to PDF ?

The new version of GitBook no longer supports exporting to PDF and other ebooks format. A lot of rich-content does not translate well from the Web to PDF. GitBook will expose a developer API for people to consume and extend their content. It is not excluded that someone build a PDF export tool using the API, but it will not be officially supported.

Offline access is a different matter, and if relevant, we might implement it officially in the future. It will just not be in the form of a PDF export.

Where does GitBook store user data ?

All user data and content is stored in the US on Google Cloud.

Some content (e.g: HTML pages) may be cached by our CDN in other countries to improve end-user performance.

Can I browse existing projects on GitBook ?

The new version of GitBook does not have the same "Explore" feature than the legacy version, since it now focuses on products, teams and companies documentation. Public documentations are still indexed by search engines though and can be found there.

Why do you need my phone number?

To create and confirm your account, you may be requested to verify your phone number with a verification code sent on your mobile phone.

This extra security step has been set up for several reasons, but the most important one is probably to limit spam and scam content on GitBook. Unfortunately, malicious users and bots are trying to use GitBook to host unauthorized content on our platform. To limit this behavior, we need to verify that you are a real human.

Your phone number will only be used for this security step and you WON'T receive ANY further communication on this channel.

Can I edit the markdown source ?

The new GitBook doesn't offer a way to edit documents in their Markdown form. We no longer store Markdown or HTML, instead we store rich JSON data structures. Markdown can still be used as shortcuts or through the GitHub integration. For more details about the reasoning, have a look at "Editing Markdown source".

I can't login, or once logged in the page is empty.

We're aware of some issues between Google Services and some providers in China that could limit or block your access to GitBook. Most of our users were able to find a solution, using a VPN but we're still monitoring closely the situation.

Does GitBook support RTL languages?

We have RTL support in mind, but it's not yet ready. For now, only paragraphs and headings will automatically detect RTL text and adapt their layout. Lists and other content blocks are not aligned properly. Also, you may have noticed a poor font quality being used for your language. We have plans for potential custom fonts support, so you should be able to use the appropriate font for your usage.