New in GitBook: Free open source documentation that helps fund your project
Product updates
24 Oct, 2024
At GitBook, part of our mission is to lift up and support open source projects. Not just because itâs where we started as a company. Because we believe that open source knowledge will empower the next generation of developers to build amazing products.
So today, weâre announcing a new free docs site plan thatâs designed specifically for open source projects. Itâs designed to help open source developers and teams create incredible documentation for their project for free â and earn funding every time someone views it.
What is a Sponsored site?
Letâs start with the basics â docs sites are how you publish documentation in GitBook. You write your content, add it to a docs site, add the customizations you want, then publish it to the world. Simple!
We have a few docs site plans to choose from depending on your requirements and budget, and those are great for most users. But for open source documentation, weâve also created a new Sponsored site plan with all the features you need â including customization, data insights and integrations. And itâs completely free.
The Sponsored site puts a small, relevant ad in the corner of your projectâs docs â and you keep the ad revenue. Every view will earn you money, and you can use it to fund ongoing development of your project, or for whatever else you choose.
Most importantly, we believe strongly in ethical advertising. So we guarantee that the ads in your docs will never track or retarget your users.
We also know that some of you really donât like the idea of ads on your docs. We understand, so youâll always have the option to publish your docs as a free Basic site, or a Premium site with more features. The choice is entirely yours.
Itâs also really important for us to stress that GitBook isnât taking a cent from ads on open source projects â you keep it all. This is just one small way for us to say thank you to all the OSS project maintainers and contributors who do such incredible work.
Why are we doing this?
The short answer is: we want to give back to the open source community, and we want everyoneâs docs to be great. And we think GitBook is the best platform to help you build incredible docs.
We know you could easily add your docs to your project in GitHub as a README.md file. Or even build your own docs platform and host them there.
But docs in GitHub are hard to navigate, and donât always present information in a useful, organized format. And custom documentation platforms take time and effort to maintain â time you could be spending on your OSS project.
We want to simplify things. Write great docs in GitBook, sync them with your GitHub repository, and simply select the Sponsored site plan in the app to create your site. Thereâs no application and no need to contact support â just choose a plan, add some customizations and publish your docs. Then once your site is approved, watch the money in your account slowly tick up.
Git Sync is the game-changer
To create and publish your open source docs for free, you can sign up for a Free core plan to create or import your content and access GitBookâs editing tools, then set up Git Sync in your GitBook organization.
With Git Sync, you can sync your documentation to a GitHub or GitLab repository, and any changes you make in one will sync with the other. So if you already have documentation in GitHub, for example, you could sync your repo with GitBook to add all that content to a docs site in minutes.
Even better â if there are people who help maintain your projectâs documentation, they can create their own branch, make some edits to your docs, then open a pull request and as for a review when their changes are ready.
In GitBook, youâll be notified that you have changes to review, and can check them in the GitBook editor, open a preview to see the changes in context, then merge them when youâre happy. Itâs all built into the GitBook app and available with our Free plan at no extra cost.
That means you only need one free GitBook user for your projectâs documentation, and everyone else can contribute through GitHub or GitLab. So great docs donât have to cost you a penny.
Our commitment to open source
Along with this new docs site plan, we recently announced a new open source fund. This is another way for us to show our support to open source development teams doing work thatâs integral to GitBook and many other products.
You can read more about the fund in our recent blog post, including which projects weâre sponsoring and how much weâre giving each year.
How do you get the Sponsored plan?
Once youâve created your GitBook organization, simply create a new docs site to open the site creation wizard. When youâre prompted to choose a plan, select the For open source option and select the Sponsored plan from the list.
Once your site has been live for seven days you can submit it for an ad review. Head to your siteâs settings, then scroll down to the Ads and sponsorship section. Here, review the ads checklist to make sure your site meets all the requirements before submitting.
Head to our documentation to find out more about how the process works and what to expect once youâve submitted your site for review.
Alternatively, head over to the open source page on our site to find out more about everything weâve talked about here and see all the features included with a Sponsored site.
Thank you again to all open source maintainers and contributors for your amazing work. We hope to see your docs looking great in GitBook soon.
â Explore how GitBook can power your open source project
Author
Latest blog posts
Get the GitBook newsletter
Get the latest product news, useful resources and more in your inbox. 130k+ people read it every month.






