New in GitBook: Our published documentation is now open source, so you can contribute
New in GitBook: Our published documentation is now open source, so you can contribute
Product updates
Product updates
Product updates
27 Mar 2024
Open-source documentation from GitBook
Today, we’re opening up our published documentation so everyone in our community can see and contribute to our code. This is a huge moment for us at GitBook, and we’re so proud to be returning to our roots.
But what does that mean for you? Well, now that our rendering engine for published content is open source, you can contribute to the project in all kinds of ways.
Spotted an annoying bug and think you can fix it? Jump in and open a pull request. Got an idea for a feature you’d love to see? Make it, submit your suggestion, and chat with our team! Want to localize GitBook’s UI into your own language? Go ahead — it’s easy.
Why make GitBook published docs open source?
Beyond giving you the tools to make GitBook better in ways that matter to you, we’re doing this because we want to get back to our origins as a software company. GitBook started life as an open source project more than 10 years ago, and we’re so excited to be rejoining the open source community.
Of course, the other big benefit is transparency. We want to build GitBook in public, and this lets you see how we built our product and take a closer look at our code. If opening our published docs repository helps even one person build an amazing piece of software it’ll be worth it.
This new open source initiative sits perfectly alongside our API. It lets you build integrations to make your docs richer and more interactive, or even plug into other apps and services that you use every day.
Our users have already built some amazing integrations, including Storylane and Supademo — so why not join them? Head to our developer documentation to find out more.
An incredible partnership with Scalar
A few weeks ago we released some more big updates to published documentation, including improved OpenAPI blocks. And today, we’re thrilled to announce that we’ve partnered with Scalar to make them even better.
Thanks to the hard work of the team at Scalar, you’ll now see a Test It button on OpenAPI blocks in your published documentation. Clicking it will open up an API client, where you can add headers, cookies, variables and more — before sending the request to test your API live.
If you’ve added the API key, GitBook can pre-populate the client. Plus, the client saves a history of all your requests, so you can easily revisit a previous one any time you need to.
We’re thrilled to work with Scalar on this — a huge thank you to the team for making our new OpenAPI blocks even better. We hope you love the new functionality!
We love open source projects
In case it wasn’t obvious, we love open source software here at GitBook. That’s why we’ve contributed more than $23,000 to open source projects since 2022 — mostly to those that help make GitBook what it is. We’re so grateful for the hard work of the teams behind these projects, and many more just like them. If you don’t already, go support open source software!
This is one reason why we offer a free Community plan to qualifying organizations. It includes everything your team needs to scale your public projects — and it won’t cost you a penny. Head to our documentation to check whether you qualify for the Community plan, and how to apply.
Stay tuned for more
This release has been the culmination of a lot of hard work from our team, and we’re really excited to share it today. But this isn’t the end — not by a long way.
We’ll continue to focus on our open source project, and improve published documentation for everyone. And of course now, so can you! We can’t wait to start seeing your contributions to the app — we know GitBook is going to be so much better because of them.
Don’t forget to join our GitHub community to discuss the project, GitBook’s features and more. It’s the perfect place to start if you want to contribute to GitBook now and in the future.
Open-source documentation from GitBook
Today, we’re opening up our published documentation so everyone in our community can see and contribute to our code. This is a huge moment for us at GitBook, and we’re so proud to be returning to our roots.
But what does that mean for you? Well, now that our rendering engine for published content is open source, you can contribute to the project in all kinds of ways.
Spotted an annoying bug and think you can fix it? Jump in and open a pull request. Got an idea for a feature you’d love to see? Make it, submit your suggestion, and chat with our team! Want to localize GitBook’s UI into your own language? Go ahead — it’s easy.
Why make GitBook published docs open source?
Beyond giving you the tools to make GitBook better in ways that matter to you, we’re doing this because we want to get back to our origins as a software company. GitBook started life as an open source project more than 10 years ago, and we’re so excited to be rejoining the open source community.
Of course, the other big benefit is transparency. We want to build GitBook in public, and this lets you see how we built our product and take a closer look at our code. If opening our published docs repository helps even one person build an amazing piece of software it’ll be worth it.
This new open source initiative sits perfectly alongside our API. It lets you build integrations to make your docs richer and more interactive, or even plug into other apps and services that you use every day.
Our users have already built some amazing integrations, including Storylane and Supademo — so why not join them? Head to our developer documentation to find out more.
An incredible partnership with Scalar
A few weeks ago we released some more big updates to published documentation, including improved OpenAPI blocks. And today, we’re thrilled to announce that we’ve partnered with Scalar to make them even better.
Thanks to the hard work of the team at Scalar, you’ll now see a Test It button on OpenAPI blocks in your published documentation. Clicking it will open up an API client, where you can add headers, cookies, variables and more — before sending the request to test your API live.
If you’ve added the API key, GitBook can pre-populate the client. Plus, the client saves a history of all your requests, so you can easily revisit a previous one any time you need to.
We’re thrilled to work with Scalar on this — a huge thank you to the team for making our new OpenAPI blocks even better. We hope you love the new functionality!
We love open source projects
In case it wasn’t obvious, we love open source software here at GitBook. That’s why we’ve contributed more than $23,000 to open source projects since 2022 — mostly to those that help make GitBook what it is. We’re so grateful for the hard work of the teams behind these projects, and many more just like them. If you don’t already, go support open source software!
This is one reason why we offer a free Community plan to qualifying organizations. It includes everything your team needs to scale your public projects — and it won’t cost you a penny. Head to our documentation to check whether you qualify for the Community plan, and how to apply.
Stay tuned for more
This release has been the culmination of a lot of hard work from our team, and we’re really excited to share it today. But this isn’t the end — not by a long way.
We’ll continue to focus on our open source project, and improve published documentation for everyone. And of course now, so can you! We can’t wait to start seeing your contributions to the app — we know GitBook is going to be so much better because of them.
Don’t forget to join our GitHub community to discuss the project, GitBook’s features and more. It’s the perfect place to start if you want to contribute to GitBook now and in the future.
Open-source documentation from GitBook
Today, we’re opening up our published documentation so everyone in our community can see and contribute to our code. This is a huge moment for us at GitBook, and we’re so proud to be returning to our roots.
But what does that mean for you? Well, now that our rendering engine for published content is open source, you can contribute to the project in all kinds of ways.
Spotted an annoying bug and think you can fix it? Jump in and open a pull request. Got an idea for a feature you’d love to see? Make it, submit your suggestion, and chat with our team! Want to localize GitBook’s UI into your own language? Go ahead — it’s easy.
Why make GitBook published docs open source?
Beyond giving you the tools to make GitBook better in ways that matter to you, we’re doing this because we want to get back to our origins as a software company. GitBook started life as an open source project more than 10 years ago, and we’re so excited to be rejoining the open source community.
Of course, the other big benefit is transparency. We want to build GitBook in public, and this lets you see how we built our product and take a closer look at our code. If opening our published docs repository helps even one person build an amazing piece of software it’ll be worth it.
This new open source initiative sits perfectly alongside our API. It lets you build integrations to make your docs richer and more interactive, or even plug into other apps and services that you use every day.
Our users have already built some amazing integrations, including Storylane and Supademo — so why not join them? Head to our developer documentation to find out more.
An incredible partnership with Scalar
A few weeks ago we released some more big updates to published documentation, including improved OpenAPI blocks. And today, we’re thrilled to announce that we’ve partnered with Scalar to make them even better.
Thanks to the hard work of the team at Scalar, you’ll now see a Test It button on OpenAPI blocks in your published documentation. Clicking it will open up an API client, where you can add headers, cookies, variables and more — before sending the request to test your API live.
If you’ve added the API key, GitBook can pre-populate the client. Plus, the client saves a history of all your requests, so you can easily revisit a previous one any time you need to.
We’re thrilled to work with Scalar on this — a huge thank you to the team for making our new OpenAPI blocks even better. We hope you love the new functionality!
We love open source projects
In case it wasn’t obvious, we love open source software here at GitBook. That’s why we’ve contributed more than $23,000 to open source projects since 2022 — mostly to those that help make GitBook what it is. We’re so grateful for the hard work of the teams behind these projects, and many more just like them. If you don’t already, go support open source software!
This is one reason why we offer a free Community plan to qualifying organizations. It includes everything your team needs to scale your public projects — and it won’t cost you a penny. Head to our documentation to check whether you qualify for the Community plan, and how to apply.
Stay tuned for more
This release has been the culmination of a lot of hard work from our team, and we’re really excited to share it today. But this isn’t the end — not by a long way.
We’ll continue to focus on our open source project, and improve published documentation for everyone. And of course now, so can you! We can’t wait to start seeing your contributions to the app — we know GitBook is going to be so much better because of them.
Don’t forget to join our GitHub community to discuss the project, GitBook’s features and more. It’s the perfect place to start if you want to contribute to GitBook now and in the future.
Get the GitBook newsletter
Get the latest product news, useful resources and more in your inbox. 130k+ people read it every month.
Similar posts
Get started for free
Play around with GitBook and set up your docs for free. Add your team and pay when you’re ready.
Get started for free
Play around with GitBook and set up your docs for free. Add your team and pay when you’re ready.
