Product updates

A restyle for GitBook Assistant, improved menus and more

We’ve updated the look and feel of GitBook Assistant to give your content more space, added new menus across the app with a number of improvements, and released a ton of fixes.

A more polished Assistant experience

We’ve improved the style and layout of GitBook Assistant to make it more minimal and to give your content more space. The Assistant now appears as a full-length sidebar, nudging your content over while keeping a great layout no matter the size of your screen.

You might also notice that the styling subtly matches your site’s primary color — so the Assistant blends perfectly into your site and feels more branded to your docs.

You’ll also notice improved scroll effects on the chat stream and updated animations that are smoother and, frankly, prettier when answers appear ✨ Plus, there are now up and down buttons for easy navigation through your chat log.

Hit Ask at the top of this page or click here to try the latest Assistant improvements for yourself!

Improved menus across the app

Every menu in the GitBook app has been updated with new features, improved UI and better accessibility.

First, menus now have better focus management — so you can navigate using your keyboard, and if you use your mouse, focus will remain more consistent even when selecting from submenus.

We’ve also added search to every menu. So when you open a menu, you can just start typing to narrow down the options you see.

This search also includes submenu entries. So if you open a space’s Actions menu and type ‘Share’ it will show not only the Share menu item, but also the two submenu items within it — so you can quickly find and select what you need without much manual navigation.

These changes are live now across all menus in the app, so give them a try today.

Better code syntax highlighting, custom links for your site logo and more

With this release, we’ve made your site logo link customizable, plus added Shiki syntax highlighting for code blocks, a new block switching menu, and more.

Set a custom link for your site logo

You can now set a custom link for your docs site’s logo in the top-left corner of your published docs.

By default, clicking the logo or site title will lead users back to the first page of your docs site. But you can now set a custom URL outside your site — or a page, section or variant on your site — to be opened instead. If your docs are part of a larger website, this can help visitors navigate back to your own landing page

To set a custom link, open your site’s Customization settings and switch to the Configure tab. In the Primary link section, add the URL you want your logo to link to.

Shiki syntax highlighting in code blocks

Code blocks in the editor now use Shiki for syntax highlighting, so they’ll render much more consistently with code blocks in your published docs.

That means that your code blocks won’t just have great performance. They’ll also match the same highlight colors as in your published docs — including your site’s custom primary and semantic colors.

Switch block types faster

We’ve added a new option to our inline palette that lets you quickly switch block types with a couple of clicks.

Simply highlight some text in a block and, in the palette that appears, use the dropdown menu to select a block to turn it into. It’s as simple as that!

Embed GitBook Assistant in your product or website

Earlier this year, we released GitBook Assistant — a powerful AI tool that helps your users when they’re browsing your documentation. It was our first step towards what we see as the future of documentation, where product and docs are more intelligently connected.

Now, we’re adding ability to embed the same GitBook Assistant from your docs directly into your product or website.

So your users can access knowledge from your docs — and other tools you choose to connect via MCP — without needing to switch tools. And you can improve customer success by offering them seamless, context-aware answers and suggestions. Paired with adaptive content, it’s like giving every user a personalized product expert, available 24/7.

Head to our Embedded GitBook Assistant docs to learn more about how to get started.

This is a huge step towards our goal of bringing documentation and product closer together. We’d love to hear your initial feedback as it rolls out in beta.

Adjustable page covers, performance improvements and more

Adjustable page cover heights

If you’ve added a cover image to your page, it’s now easier than ever to adjust the size to your liking.

You can use the drag handle or keyboard controls to make it taller or shorter, and you can see the percentage size of the image so you know it’s going to fit properly.

We’ve also added a crosshair to the UI, so that when you drag to reposition the cover you know when it’s perfectly centered.

Big improvements to editor performance

Working on your content is now faster and more performant than the editing experience in Notion. We’ve been working on backend improvements over the last few weeks, and we’ve now achieved a 2x performance improvement in the editor.

Our work on performance and stability improvements continues, but we wanted to share the results of our work with you as we hit this milestone!

Improved inline palette

When you’re editing your work and select something on the page, the inline palette appears to offer you important controls like formatting, links and annotations.

With this release, we’ve rebuilt the behavior of the palette from scratch. It’ll now be more stable if you scroll when it’s open — and it won’t blink when the selection changes. Plus, we’ve just made some overall improvements to performance and moved the link palette so it now appears below your selected text, not above it.

Search result breadcrumbs, better variant + language support and more

Breadcrumbs in search results, better support for languages and versions on the same docs site, a new comments popover panel and plenty of other improvements and bug fixes.

Breadcrumbs in search results

If your site is complex — with a lot of sections or variants — sometimes it’s hard to know if search is taking your users to precisely the page they need.

To make it easier for your users to be confident about choosing a result, we’ve added breadcrumbs to search results. Now they won’t just see the page title and relevant text from the page — they’ll also see the site section, variant, and page group that it lives inside.

Search will show a maximum of three breadcrumbs — if there are more, it’ll just show the first, second and last breadcrumb, with a … truncating the space between.

Better variant support for versions and languages

If you document multiple versions of your product and also want to offer localized versions of those docs with variants, you can now do that in GitBook — as docs sites now support both translation variants and version variants at the same time.

GitBook will automatically recognize these different variant types and show a version dropdown at the top of the sidebar, a translation dropdown in the header — or both.

When there are multiple variants in the same language, GitBook shows each of those languages in the translation dropdown in the header.

Then, the variant picker in the left sidebar will show all the variants available in that language — with the first variant opening by default when you choose a language.

Read and add comments without opening a side panel

Adding a comment or reading comment threads will no longer open the entire comments side panel by default. You can now add and review comments using a new popover menu.

That means you can more easily add comments right alongside the content you’re editing, and check threads right in context.

And if you want to review all the comments on a page or just prefer using the side panel for feedback? You can still access it from the Comments menu in the header bar.

Improvements to change requests, site search, version history and more

Improved sidebars for change requests and version history, plus search improvements, expandable code blocks and more.

A better change requests panel

This release makes it easier for you to view and filter change requests in the sidebar within a space.

First, there are new filters that let you discover change requests you’re involved in more efficiently. For example, you can find change requests based on their creator or participants — or just see those that are awaiting review. Which means in a couple of clicks you can see all the change requests awaiting your review.

The top of the sidebar also shows a few shortcuts to some of these filters, allowing you to instantly narrow down long lists of change requests in busy spaces to just the ones you need.

Site search improvements

Search has had a few upgrades with this release, making it easier for your end-users to find what they need:

• Sites now support type-ahead search queries — which means users will see relevant results even if they don’t finish the word they’re typing. For example, if you search for ‘reusab’ in our docs, you’ll see results for ‘Reusable content’.

• We’ve also improved the search filters to make the UI less obtrusive. Filters are now accessible at the bottom of the search modal — with the option to filter by site sections and then variants, if enabled for a section.

• Finally, two small things. First, you can now hit Esc to close the search window. Plus, AI search now has a nice little animation to make it clear it’s working on an answer — plus a back button to get back to the standard search.

Easier version history browsing

You’ll now see a specific time and date next to each entry in the version history panel, making it easier to find the version you want when browsing back in time.

Talking of going back in time, we’ve also improved the rollback confirmation message, to make it clearer what will happen.

Finally, we’ve fixed a bug that would reload the entire page when navigating between entries in the version history — now only the content of your page will refresh.

Expandable code blocks

You can now choose to make code blocks collapsed and expandable in your docs — perfect for when you have long code blocks that take up a lot of vertical space.

In the editor, simply open the block’s Options menu and enable Expandable. The block will show the first 10 lines of code, with a button to expand to show the rest. Here’s how it looks in practice!

// Simple text summarizer demo using OpenAI API
import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.OPENAI_API_KEY,
});

async function summarizeText(text) {
  try {
    const response = await client.chat.completions.create({
      model: "gpt-4o-mini",
      messages: [
        { role: "system", content: "Summarize text concisely." },
        { role: "user", content: text },
      ],
    });

    const summary = response.choices[0].message.content;
    console.log("Original text:", text);
    console.log("\nSummary:", summary);
  } catch (error) {
    console.error("Error generating summary:", error);
  }
}

// Example usage
summarizeText("GitBook helps teams create, scale, and adapt documentation intelligently with AI.");

New keyboard shortcuts, block duplication, colored inline icons and more

Quickly switch between paragraphs and headings, duplicate blocks with a tap, add colored icons to your page and more.

Faster heading and paragraph block switching

We’ve added a few new keyboard shortcuts that let you quickly switch a text block between paragraph, H1, H2 and H3. Simply click anywhere in the block you want to switch and hit one of these shortcuts:

We’ve been using it while writing this changelog and it’s great — especially when you forget to hit # at the start of an empty line and you want a header block.

Duplicate any block instantly

One more neat shortcut to speed up your editing workflow: you can now duplicate any block by either hitting ⌘ + D (on Mac) or Ctrl + D (on Windows), or by holding the Alt key and dragging.

If you use the shortcut, a duplicate of your active block will appear below. If you drag, you can place your block anywhere you like on the page.

And of course, it works for more than one block as a time, too — so you can select multiple blocks and duplicate them all with a quick tap.

Add color to inline icons

You can now select a color for inline icons when you add them to your content

This is great if you want to attract attention to certain parts of your page content — or if you just want an inline icon to match the color of your text .

There are six colors to choose from — and if your space is published on a site, you can also choose the primary and semantic colors for the site to align your icon perfectly with the surrounding text.

To change the color of the icon (or choose a different icon from the picker), simply right-click it in the editor.

Quote search for internal content

We now support exact phrase matching for internal search within GitBook.

If you want to find an exact phrase within your docs without bringing up similar matches in your search results, you can now add quotation marks around your text. Remove the quotation marks and the search will work the same way as before, highlighting close — but not exact — matches.

Better migration support, improved search and more

Migration and import improvements, searchable reusable content & API specs, and a bunch of other improvements and bug fixes.

Migration just got easier

This month we’ve improved our import and migration tools.

First, we’ve tweaked the UI copy on the import page to make it clearer that you can easily import your content directly from other docs platforms by simply pasting the URL of your current docs into GitBook.

We now also support .docx imports, making it easier to migrate your knowledge from Microsoft Word docs directly into GitBook. And we’ve added new imagery to the import screen to make it easier for you to find the option you need (and just make the UI look nicer).

We’re still working on making import and migration to GitBook even simpler, so stay tuned for more.

Search reusable content & API specs

We’re currently rolling out a new search backend that also indexes reusable content and API specs, making them easier to find when searching your content. We’re currently running through the reindexing process for every GitBook organization. Once that’s complete, we’ll start enabling it for all organizations.

Get started in empty spaces faster

We all know how blank page syndrome can mentally block you when working on something new. To help you get started in an empty space, we’ve added some quick actions that let you instantly add a heading, image, hint, expandable or code block to an empty page with a single click.

We hope that this will kickstart your creativity while you’re working on new content — and we have more ideas to help with this that we’ll talk about soon.

Frame your images for visual clarity

Image blocks are great for showing off your product, but sometimes the image can blend with the background of your site, potentially confusing users.

To combat this, you can now add a frame to image blocks to give your images a consistent look and visually separate them from their surrounding content.

To add a frame, hover over the image, open the Options menu and enable the With frame toggle.

Here’s how framed images look in published docs:

Comment threads get a better home

When leaving feedback on a change request or page, we noticed that the comments panel could sometimes get a little long, with full threads displaying by default.

To combat this, we’ve removed threads from the full comments panel. Now, a button below the comment will show if it has any replies, and clicking the comment or the button will open the thread full in the side panel.

You can also click the new Expand side panel button to make the panel larger — perfect for longer or more detailed discussions.

Nested section groups, new change request review options and more

We’ve added nested group support for site sections, allowing you to create hierarchical navigation — plus a few other improvements and fixes.

Nested section groups

Support for nested section groups is here! You can now add multiple section groups within a section group and give them all a title and icon. You can even mix sections and nested section groups together — the sections will display in a separate area within the group menu.

We’ve also made some small quality-of-life improvements to the section header. They include a new scrolling system that adds faded edges and scroll buttons when your sections are wider than the container, and some fixes that make sections and groups more responsive and better positioned.

A new toolbar when viewing your docs

You may have noticed a new toolbar that appears when you’re viewing your live docs site, or when viewing a change request preview in its own tab. This new toolbar gives you quick access to useful options with a click — and you can minimize it if you don’t need it.

In a change request preview, the toolbar lets you quickly leave feedback on the change request, view the live site, view the change request in the GitBook app or jump to the editor. This toolbar is only visible to people viewing the change request preview.

A similar toolbar now also appears on you live docs site, only for members of your organization who are logged into GitBook. So if you or a teammate visits your live site, you’ll see the toolbar and can quickly jump to the docs in GitBook to change settings, customize the site, check the insights or edit the content.

Review process improvements

We’ve been working on improvements to the review flow to take advantage of the new side panel we recently launched.

We’ve tweaked the icon for adding reviewers from a cog (which took inspiration from GitHub) to a plus + icon — which makes it clear that it lets you add more reviewers.

We’ve also added a new system that marks previous reviews as outdated when you request a new one — or when you add a new review to a change request you’ve already reviewed. Plus, we’ve added a button that lets you re-request a review.

MCP docs server generator, new search controls & more

You can now MCP servers so AI tools can interact with your docs, plus we’ve added new controls for users searching your docs, improved the page outline, and more.

Generate an MCP server from your docs

GitBook can now automatically create an MCP server for your documentation.

When enabled in your site’s customization options, you give your users the option to quickly copy a link to your MCP server and connect it to other tools. By doing this, your users can access knowledge from your docs in whichever platform they choose to connect to.

For example, if your user adds your docs MCP server to VS Code, they could quickly answer questions or add information from your docs into their coding environment via calls to the MCP server.

You can enable or disable this this in your site’s Customization > Configure menu, under Page actions. Once enabled, users can quickly copy a link to your docs MCP server from the Page actions menu and paste it into configuration sections on other platforms.

We’re adding this to our extensive list of other AI documentation optimizations — including llms.txt and llms-full.txt, easy Markdown page exports, and quick options to open pages in ChatGPT or Claude.

Search scope controls

We’re adding a new way to control search scope on your docs site.

Before, users could only choose the search scope if your site used variants for things like localizations or versioned docs. Now, your users can also choose which site sections to search within.

By default search will always show the best match — which is the user’s current variant and the default variant of every other section. They can choose to only search in your current section, or broaden the search to include all variants across alls sections.

No matter what, GitBook will automatically show the right set of buttons to make it as easy as possible for your site’s visitors to find what they need. For example, in our own docs we only show two buttons — because we have no variants.

It’s also worth noting that we no longer include language variants in the search scope. We assume most users won’t want to search multiple languages, and results in other languages can be confusing and take up space in the results section.

Page outline improvements

We’ve made some small but useful improvements to the page outline in our editor.

First, we’ve separated the On this page title from the outline itself and added an icon to make it easier to find. Plus, the title now stays sticky, even on long pages with lots of sections.

We’ve also improved the scroll behavior for longer pages. If the page outline is scrollable, it stays in sync with the page’s scroll position, keeping the active item at the top as you scroll.

We think this will make scrolling through your content — especially on longer pages — much easier.

Merge rules, improved language selection and more

New ways to control when change requests are merged and by whom, plus improvements to localization support, change requests and more.

Merge rules

With this release, we’ve introduced merge rules for change requests.

Merge rules let you define specific requirements that must be met before a change request can be merged. You can set rules within each individual space, or set rules that apply across your entire organization, which you can then override within a single space if needed.

We’ve made it easy to configure with a bunch of presets to match your team’s requirements — from requiring the change request to have a subject, to requiring review from specific members. You can combine rules in any way you like to build more complex workflows, as well as write dynamic expressions using the same language as for adaptive content.

When a change request hasn’t met all the merge requirements, the Merge button is disabled and a tooltip explains why it can’t be merged.

We’re rolling this out starting with early access users today. It will be available for everyone on the Pro plan soon. This feature has been requested a lot recently, so we’re super happy to ship it!

Improved language selection

If you’ve used translations to localize your site into different languages, we’ve improved your users’ experience when browsing your docs.

A new language picker now appears in the top-right of the screen, allowing site visitors to select their preferred language — and that language will be maintained when navigating between site spaces and within search results.

We’ve also added language options to the Structure section of your docs site settings, allowing you to quickly and easily select the UI language for your docs site as well.

Change request descriptions

Change requests just got more powerful, with a new sidebar that lets you add a description and easily view and add reviewers.

Open the Overview sidebar in a change request and you can see its status, quickly copy a link to it, add a description and manage reviewers. The UX should be familiar to anyone who uses GitHub.

This will become especially useful with the upcoming launch of Docs Agents, but it also allows you and your team to add more context to change requests and more easily manage your review flow — especially when paired with merge rules.

Vertical alignment in column blocks

You can now vertically align content in a column block. It’s ideal for creating centered or bottom-aligned content — such as when building landing pages or adding context to an image.

Fit and fill options for card images

You can now choose more display options when it comes to card images.

Previously, images would automatically be cropped to either 16:9 or 1:1 depending on your readers’ screen size. But that meant your images could sometimes be cropped incorrectly, and portrait images would never display in full.

Now, you can choose between three options:

1. The image crops to 16:9 or 1:1 as before.

2. The image stretches to fill the entire box.

3. The image displays in full within the constraints of the box, with your primary color filling any background space.

Auto-updating translations, AI Assistant improvements and more

Introducing an all-new, super simple way to localize your docs and maintain the translations — plus smaller improvements to Assistant, better LLM-ready docs and more.

AI-powered, auto-updating translations are live

You can now automatically localize your entire docs site into 36 languages at the click of a button using our new Translations feature.

Translation uses AI to automatically translate your docs content into whichever language you choose — and will automatically update those translated versions of your docs whenever you make a change to the primary language version.

Simply choose the space you want to translate, select the source and target languages, and let AI do the rest. You can add specific instructions, such as a tone of voice or writing style, right from the modal. And you can also add a Glossary for individual languages if there are certain words or phrases that you want to be translated in a specific way across all your translations.

Once created, these translated spaces can be easily added to your docs as a variant, and any time you make a change to the original source space, the translated version of the space will auto-update following the same instructions and glossary.

That’s localization, simplified. Find out more in our docs!

GitBook Assistant improvements

After GitBook Assistant’s launch a few weeks ago, we’ve been making a bunch of small refinements to the way that it answers questions and helps your users.

First, we’ve upgraded the model, allowing for faster answers and more optimized outputs. We’ve also refined the prompt even further, which means users will get better, more accurate answers with better references.

Plus, we’ve added new auxiliary prompts to improve the quality of the recommended questions and the follow-up questions that appear in the chat after each response. You should notice that the recommended questions are shorter and more interesting, while follow-up questions will be more on-topic than before.

We’ll have some other, larger improvements for Assistant soon — including new ways to integrate it into your product. Stay tuned!

Russian language support

We’ve added an interface localization option for the Russian language in the published docs interface. When enabled in your site’s Customization menu, the interface of published docs will be translated into Russian.

Thanks to Rex Gratidian for contributing this localization. If you want to contribute to improving GitBook’s published docs, please head to our GitHub repo to find out more!

Better Markdown support for your LLM-ready docs

We’ve made a big improvement to the way our API returns Markdown for a page, so that it now outputs the content of reusable blocks and OpenAPI blocks just like other content.

This is super important, as the .md version of a URL is useful for LLM ingestion — so making sure all of your docs are LLM-friendly is vital. Now your GitBook docs are super LLM-ready, right out of the box.

Light and dark card images

You can now apply a light and dark mode image to any card — just like other images in GitBook.

To do this, open the Card options menu and choose Cover > Edit cover > Add cover for dark mode. The correct cover image will show automatically depending on the user’s settings.

We’ve also added the option to create cards that only feature a cover image. So you can remove all other fields within a card and simply show a grid of images, if you like.

A bunch of editor improvements

We’ve been working on a ton of smaller improvements across the editor, including:

• More consistently centered content within the editor across all screen sizes, to stop content moving around when you open or close different sidebars in the app.

• An improved page outline which stays sticky next to the content editor. We’ve increased the visibility conditions so you’ll see it more often, simplified its logic, and added stepper blocks to the outline so you’ll see each step listed alongside other section headers.

• We’ve fixed diff view, which wasn’t showing the diffs on some smaller screens. Now you’ll see diff markers by each block that’s changed.

• We’ve also fixed a bug that meant the comments button could be cut off on smaller screens. Now it will appear as expected, ready for you to give feedback.

GitBook Assistant, improved insights, new AI actions and more

This release introduces a supercharged new AI assistant, improved insights options, a new wider page width option that’s perfect for building landing pages, and much more.

GitBook Assistant — knowledge from your docs and beyond

As part of yesterday’s adaptive content launch we also introduced GitBook Assistant — a powerful new AI experience for your docs.

Assistant is a big step up over our previous AI search functionality. While our old solution was fast and gave end-users accurate answers based on your docs, GitBook Assistant offers a new chat-based UI, seamless integration with adaptive content, and the option to connect with MCP servers to provide better answers with more context.

As well as using agentic retrieval — which gives it a deeper understanding of user intent, and more accurate responses — it’s also integrated with adaptive content. So it can use knowledge about an individual user to give better, more tailored answers.

It can also connect to other sources via MCP servers, meaning GitBook Assistant can pull information from different sources and use that information to answer questions with even more context.

Read more in our announcement post, or head to our demo site to experience its adaptive content integration.

Time ranges and AI response rating in insights

We’ve made two big improvements to our built-in insights.

First, you can now choose time ranges when analyzing site data. So you can set custom time periods to review, or compare site data between two identical periods in any degree of separation.

Plus, you’ll now also see the ratings that users are giving your AI responses within the Insights panel — along with the question they asked and how many people asked similar things.

This is ideal for identifying common questions that are getting poorly-rated answers, so you can fill the gaps in your docs and provide better answers to your users.

Page actions

Your docs now feature a handy Page actions menu on each page, allowing your users to quickly ask GitBook Assistant a question, view or copy the page content in Markdown, or open the page in ChatGPT or Claude to pre-load a prompt.

Semantic colors in the editor

You can now use the semantic colors you define for your docs site — which are used to change the color of hint blocks and announcement banners in your docs — within the content itself.

If you’ve set semantic colors for a docs site and are editing the content of that site in a change request, you can now use the inline palette to change the text color and background to use the Primary, Info, Success, Warning or Danger colors you’ve defined for that site. These colors will sync with the semantic colors in your docs to bring everything in line.

New “Wide” page width option

We’ve added a new Wide page width option, which is perfect for creating eye-catching landing pages.

To enable the option, open the page you want to widen and open the Page options menu that appears when you hover over the page title.

There, you can set the page width to Wide, which will automatically expand all blocks that can be expanded, and align the rest of the blocks within the bigger container.

Head over to our demo site to see how it looks.

Page metadata

GitBook automatically creates page metadata — including when the page was updated and who updated it. These are both shown by default in the editor, and ‘Last updated’ also appears on published pages.

Now, you have the option to disable that metadata on a per-page basis. Open the Page options menu and in the Footer section disable the Page metadata option to hide the data from readers.

OpenAPI spec validation improvements

We’ve made some improvements to our OpenAPI specification validation process. These updates should identify issues with the spec file earlier, so your docs stay consistent and reliable for your readers.

If you’ve experienced any issues with your OpenAPI spec in GitBook, try pasting it into http://editor.swagger.io/ to check for formatting or structural problems. And if you’re still having trouble validating your spec, feel free to reach out to our support team at support@gitbook.com.

Variables, redesigned search, better diff view and more

Create and add reusable variables to your docs, plus a redesigned search experience for your published docs, and other editor improvements.

Introducing variables in GitBook

With this release we’re introducing variables.

If you repeat the same name, phrase or version number multiple times within your content, you can create a variable to help keep all those instances in sync and accurate — which is useful if you ever need to update them, or they’re complex and often mistyped.

You can create variables scoped to a specific page or a specific space, and then use them as many times as you like within a space by adding inline expressions.

For example, you might want to add variables such as:

• product_name

• version_number

• email_support

• account_type

By using variables like these, you could easily update a product name or version number across your entire docs, simply by updating the variable itself.

To view, add and edit your variables, click the Variables icon in the header bar within a change request.

You can then use a variable to your content by adding an expression. Hit / and choose Expression from the list, then double-click the expression to open up the expression editor where you can choose the variable you want to add.

Variables are super useful on their own, but become even more powerful when paired with adaptive content. We’ll talk about this combination more in the coming weeks.

Search gets a new design on docs sites

We’ve improved the search experience for published sites, with the Ask or search… bar now holding the search experience in one place, without overlapping all of your content.

Before, the search panel would sit centrally over all of your page content, blocking users from seeing it while they searched.

Now, users type directly into the search bar — which holds both the standard keyword search and the GitBook AI search experiences.

Diff view for title and description

Diff view helps you and other reviewers see what’s been edited within a change request. And now it also shows when a page’s title or description has changed!

Better breadcrumbs when editing a space

We’ve improved the breadcrumbs in the editor to make it easier for you to quickly access site settings directly from a space.

When you’re editing a published space, you can click the icon of your site in the top-left of the editor to open a new site menu.

Here, you can instantly access your main site overview, insights, customization and settings. You can also visit the site or copy the site’s URL, saving you time clicking into different parts of the GitBook app.

Not only does this make it easier to jump to important areas right from your content — it also saves space in the header — and we think it looks great, too.

Custom code fonts, make your API spec public and more

You can now upload your own custom font for code blocks, create new sites more easily, make your API spec public and more.

Set a custom monospace font for code blocks

You’ve been able to upload a custom font for your docs for a while — but now you can do the same for a monospace font for code blocks and inline code.

To change your code font, head into your site’s Customization panel and select from the Monospace font dropdown menu.

Share your OpenAPI spec from your docs

You can now choose to generate a publicly-accessible URL for your OpenAPI specification once you’ve added it to GitBook — as long as your specification is marked as public. The URL will always point to the latest version of your specification.

With GitBook hosting your spec, it’s easy to use it both to instantly generate docs, and in external OpenAPI-based tools like Stainless, Postman or others.

Head into the OpenAPI section in the GitBook sidebar and find the API you want to make public — then simply hit the toggle.

Improved notification emails

Last month we improved a few of our emails with a better design and more context about the subject — and we mentioned we’d be doing the same to more emails soon.

Well, now we have! Our emails now all use this new improved style ✨

Simplified site creation flow

When you create a new site, you’ll now see a dashboard that’s more tailored to what you want to do.

First, you’ll see four large options at the top to offer you different ways to add content to your site — including Git Sync, OpenAPI spec upload, and import options.

Below that, you’ll also see four site templates to help you get started with an all-new site faster by adding content to an established structure.

Finally, you’ll see a list of all your existing content within GitBook, along with a search bar, allowing you to quickly add existing content to your site and publish with a click.

These changes should make it easier to create an publish your site fast 🏎️💨

Performance upgrades, llms-full.txt and .md support, text alignment and more

Your docs sites load faster and support llms-full.txt and .md for LLM ingestion — plus you can now add icons to buttons, center- or right-align text on the page, and much more.

Your docs site just got faster

Over the past few weeks we’ve been slowly rolling out a new platform for our public docs. It’s faster, more performant, and it prepares us for our future plans regarding adaptive content.

The great news is that this new, improved platform is now live for everyone.

We rolled this out slowly because we handle 150 million requests on docs hosted by GitBook every day, and each one makes multiple requests to our API. The slower rollout meant we avoided downtime caused by overloading the API with requests, and means we can now optimize how we generate pages to improve loading times.

That means your users will get improved performance in your docs, and there are a few other benefits as well…

llms-full.txt and .md support for LLMs

Our new docs platform means your docs now automatically create an llms-full.txt file, which includes all of the content on your entire docs site.

llms-full.txt is a new proposed standard for making web content available in text-base formats that are easier for LLMs to process. You can access the llms-full.txt page by appending /llms-full.txt to the root URL of your docs site.

The llms-full.txt file provides a comprehensive collection of all your site’s content in Markdown formatting. With this file, you make it easier for LLMs to efficiently discover and process your documentation content.

You can also now add .md to any page’s URL in the browser to see the content of that page rendered in Markdown.

This is great for LLMs as well, which find it much easier and more efficient to process Markdown than a full HTML file with all the styling your docs site page includes.

Add icons to your inline buttons

Last month we added inline buttons to docs, and last week we added inline icons. Now, we’re combining the two!

You can now add an icon to any button you add to your docs, allowing for more customization, and helping you attract more attention to your CTAs.

Read the docs Go to top

Center align headings, paragraphs and inline items

Want to build a polished landing page, add some more structure, or even make your docs the homepage for your entire product? That’s just got easier with alignments in GitBook.

You can now align header and paragraph blocks to the left, center or right of your page, allowing for more flexibility when you’re designing your content.

Add centered titles to build a clean landing page. Right-align an image or some buttons as a CTA to read more. You can even combine alignments with our new column blocks and button icons to create variations on specific layouts you like. Here’s a quick example:

Getting started

Paygrid Checkout

Get set up, connect with your current order flow, and start getting paid in minutes with Paygrid Checkout.

Integration guide API Reference

The Paygrid SDK & API

Discover our SDK and APIs and explore how you can connect Paygrid to your platform to deliver even more functionality

Explore the SDK Payments API

Select all just got better

When you hit ⌘ + A (Mac) or Ctrl + A (Windows) to Select all within certain blocks, GitBook will now first select the contents of that block. You can hit the same keyboard shortcut again to select all the content on the page.

The blocks that use this logic are tab, stepper, code, column and hint blocks.

Column blocks, inline icons and a bunch of smaller improvements

We’ve added a new block type — columns — plus inline icons, a better site structure management experience and more.

Columns: a new way to display your content on a page

Introducing column blocks!

You can use column blocks to add two blocks on your page, side-by-side. It means you can combine two of almost any block you like alongside each other to create some powerful combinations

For example, you can combine an image, some text and a few buttons to build a nice block for a landing page:

The Paygrid SDK & API

Discover our SDK and APIs and explore how you can connect Paygrid to your platform to deliver even more functionality

Explore the SDK Payments API

Or you could add some extra context to your code blocks, diagrams or other content within a guide or docs page:

Notes

• Replace 'your-api-key-here' with the key found in your dashboard under API Settings.

• Use 'sandbox' for the environment if you're testing in a non-production setup.

• This client instance will be used in all subsequent API calls in your integration.

// Step 1: Initialize the client with your API key
import { PaygridClient } from 'paygrid-sdk';

const client = new PaygridClient({
  apiKey: 'your-api-key-here',
  environment: 'production',
});

When you add a column block, you can add content to either side of the content by hitting / and choosing the block you want to add from the palette.

You can also adjust the width of the two columns using the grabber in the centre of the block. Drag it left or right to adjust the interval of the column divider — the column widths will adjust automatically.

Add inline icons to your docs content

We’ve added a new inline element that you can use in your docs — icons!

You can now add icons anywhere on your page, giving you more options when create titles, lists and much more. Head to the docs to learn more.

A simpler way to manage your site’s structure

This week we’ve improved the Structure section of your site settings, making it easier to change settings for individual site sections.

You can now see all of your site sections and groups on the left of the menu, and click on any option to view its options. On the right-hand side, you can edit options like the section’s title, icon, description and slug.

More context when Git Sync encounters issues

Before, when Git Sync encountered an error, the message that appeared in GitBook didn’t give much context about the issue.

We’ve improved the messages — they now include more information about the error so you can solve it before you retry your sync.

New customization styles, email improvements, dark mode cover images and more

You can now add circular buttons, choose flatter design elements, and select cover images specifically for light and dark mode in GitBook.

New depth and circular corner styles in site customization

We’ve added two new style options to customization settings for your docs site.

Firstly, we’ve added a new Depth style setting in the Site styles panel, which lets you choose from two depth options. ‘Subtle’ is the default style, and adds some shadows and elevation to UI elements like buttons. The new ‘Flat’ style removes all shadows and elevation for a clean, simple look.

We’ve also added a third corner style in the same panel. Along with our existing ‘Straight’ and ‘Rounded’ options, you can now also choose ‘Circular’. This will affect UI elements such as buttons, TOC highlights, site sections and more.

Cover images get dark mode support

Your page cover images no longer have to work for both light and dark mode simultaneously. Now, when you add a cover image to a page, you can also upload a dedicated version of the image to display when your docs are viewed in dark mode.

To do this, simply hover over the cover image in the editor and open the Options menu . Here you can choose Replace image and select a new image for light or dark mode.

New notification email design

We’ve improved the design and information included in the notification emails you receive when someone comments on a space or a change request your own.

The new design includes the name of the change request or space, and the page, instantly giving you more context without needing to click through and read more.

We plan to roll out similar improvements to our other notification emails soon — stay tuned for more news on that!

Commenting improvements, link UI improvements, a new dashboard and more

We’ve made comments easier to read and use, tweaked the UX for adding and editing links, fixed some bugs and made other smaller improvements.

Comment upgrades

With this release we’ve improved the design and layout of the comments side panel. Comments take up less space, and show limited options — Resolve, Edit and Delete — by default. Clicking a comment makes it active and shows more options, including Reply and an emoji reaction.

We’ve also made the on-page highlight more visible for active comments. When you select a comment the block will be highlight in orange, making it easier to see the comment in context.

You can now also filter comments in spaces and change requests by author, so you can check on a specific person’s feedback, one at a time. Open the sidebar and use the drop-down menu at the top to select or search for a user.

Finally, we’ve made the Leave a comment section at the bottom of the side panel much smaller — giving you more room to read the existing comments. Clicking the box will expand it and show more options.

Link insert palette improvements

This week we shipped a bunch more editor improvements — including a number of upgrades and fixes focused on links.

First, the link insert palette now has better search input width, so you can see more of your search or URL when adding or editing a link. The palette also now has an empty state, so it’s easier to understand what you can do with it — and it’ll accept URL strings without needing to add www. or https:// in front of them.

If you want to edit an existing external link, clicking the Edit link button now shows the existing URL in the search palette — so you can manually amend links without needing to copy and paste it in again.

New site dashboard

We’ve been working on improving the site dashboard — particularly aimed at those creating a site for the first time. The new dashboard puts all the information about your site, including the preview, URL, status audience and structure on the left-hand side.

On the right you’ll find a number of suggested actions to help you get the most from your docs site — great for those creating a new site, or just trying to make their site the best it can be. Below that is the insights overview, which gives you a quick glance at how your site performed over the last seven days.

Global reusable content and an all-new sidebar design

You can now create reusable content and add it anywhere in your organization — plus some major sidebar improvements, bug fixes and more.

Reuse content across your entire organization

We’ve made reusable content organization-wide, so you can now add any reusable content to any page, in any space in your org.

Previously, reusable content was locked to a specific space, so you could only use it there. Global reusable content means you can keep information consistent between multiple docs sites or site sections without duplicating it and risking instances getting out of sync.

You can add reusable content from other spaces by hitting / on an empty block and scrolling to (or searching for) the Reusable content section. Here you’ll see all the reusable content from the current space, along with a new menu option that shows content from other spaces.

From there you can search through all the content in your organization to find the block you need.

Major sidebar improvements

We’ve reworked the GitBook sidebar with a new design and some big upgrades.

You’ll instantly notice that there’s more space and less clutter. The content in the sidebar is now 30% more compact, so you can see more of your content at once.

We’ve also made it resizable — so you can adjust the width to fit your workflow. Plus, we’ve added a new collapsed more to help you focus on your docs content. Drag the sidebar off the left of the screen or hit the Hide sidebar button and it will slide off the screen. It’ll pop up again when your hover your cursor to the edge of the window, then hide when you move your cursor away — so you can access everything you need without expanding and collapsing it manually.

The nav has seen improvements, too. The organization button at the top now houses your settings, theme controls, and invite options — freeing up a ton of space down at the bottom of the sidebar. And the theme controls now also offer a ‘System’ setting to match the rest of your apps.

Finally, we’ve improved the Docs sites section of the sidebar. Expand a site to see all of the sections and variants within it — complete with their icons — without any unnecessary extra nesting. So you can quickly find the sites you need, navigate to the spaces within them, and collapse the sidebar to focus on your work.

Transform paragaphs into more block types

Until now, you could only turn paragraph blocks into other kinds of basic text blocks -- H1, H2 or H3 headers.

Now, you can turn a paragraph block into all kinds of other blocks. Including:

• Headings (H1, H2, H3)

• Hint

• Unordered, ordered or task lists

• Code block

• Quote

• Tabs

• Stepper

• Expandable

This should make it easier to switch your content quickly to give it more structure or add some hierarchy.

Add inline buttons to your docs, easy block selection and more

Want to add a button to your published docs? Now you can — plus we’ve made block selection easier, and made some smaller improvements and fixes.

Add primary and secondary buttons to your docs pages

You can now add buttons to your GitBook content, meaning you can now create calls-to-action right on the page.

Here’s how buttons look when published:

Sign up Read the docs

Buttons are an inline option — like emoji, links and inline images. You can add one to any text block, and they can link to any other content within your docs, or any external URL. Simply hit / to open the inline palette and choose Button.

Buttons come in two styles — primary and secondary. In the editor they’ll appear as black or white, but in published content they’ll use your site’s primary and color to style the primary button and a derivative (typically black or white) for the secondary color.

Click and drag to select blocks

We’ve added a new way to select blocks on your page — click and drag.

Before, you could select one or more blocks by highlighting the content within them and hitting Esc. Now, we’re adding a second option that makes it simple to grab large groups of blocks in one go.

Simple click and drag your cursor across the blocks you want to select to see the selection box. Releasing the mouse button will select all the highlighted blocks, ready to be copied, deleted or turned into reusable content.

Auto-updating API reference docs, design improvements, editor updates and more

There’s a new home for your OpenAPI specification that makes generating and updating API reference docs effortless, plus a bunch of other improvements.

Create auto-updating API docs in seconds

We’ve added a new way to generate beautiful API documentation from an OpenAPI specification in seconds. The new OpenAPI section in the sidebar lets you add your spec from a URL, upload it as a file, or using the GitBook CLI.

Once added to your organization, it’s super easy to use the spec to generate OpenAPI blocks — or a complete API reference — in any space.

You can update your OpenAPI specification at any time using the GitBook UI or the CLI, regardless of how it was initially added. But if you add it using a URL, GitBook will automatically check for updates every six hours. Any changes will be pushed to your API docs right away.

You can add multiple specifications to your org if needed, so you can document all the APIs you want effortlessly. And best of all, your API docs can pull all kinds of extra content from your spec file — including page icons, page descriptions, object description, and all the endpoints.

Everything is generated from the specification, and formatted beautifully by GitBook (more on that below), with on-page testing for your users.

This is how we created our own API reference docs, so head over there to check it out. Everything in those API Reference pages is pulled from the spec.

Head to our docs to read more about this — we’ve also written a handy guide if you want to get this set up for your own organization.

Improved OpenAPI and code block designs

While working on this new API process, we’ve also been working on some visual improvements to API blocks (and code blocks) to make your docs looks better than ever.

A cleaner layout for OpenAPI blocks

We’ve tweaked the OpenAPI block’s layout to remove some unnecessary separators, and make property names bolder for clearer reading. We’ve also made property titles more consistent.

Improved OpenAPI object accordions

We’ve also reworked object accordions to make them easier to work with. The entire property is now clickable, so clicking anywhere within it will reveal its child schemas. And when you hover over a property, a button will appear to show it can be expanded.

On mobile, and other devices that don’t support hover actions, this button will always appear to make it clear that the property is expandable.

New schema alternatives separators

For schemes with alternatives, we now display a new separator. The new options include anyOf, allOf, and oneOf. The separators use string translations for different languages.

New color palette for code blocks (including high-contrast version when requested by the browser)

API blocks and code blocks have also had a color update.

In published docs, API and code blocks will now use your site’s primary, tint and semantic colors to style the code blocks. So if you’ve set all your colors to carefully follow your brand guidelines, code blocks will now reflect those colors (and the effort you’ve put into adding them).

They will also show a high-contrast version automatically when requested by a user’s browser.

These changes apply to both code blocks and OpenAPI panels that contain code, so everything will be consistent across your site.

Even more editor improvements

Following on from our last few updates, the team has continued their work across the editor to improve the performance and the user experience in the GitBook app. Here’s a quick roundup of what’s new!

All-new palette styles

We’ve refreshed the palettes in the GitBook app. They are now more in line with the other UI elements and generally look a little nicer.

The change has been rolled out to all the menus in the app, and we’re working on improving the UX of some of these palettes too.

We’ve started with the link palette. It previously showed all the linkable content in your organization in one long list, which could make results tricky to find. Now, different content is separated by titles, so it’s easier to see other section on the current page, other pages in the same space, other spaces and users.

We’ve also made the inline palette searchable. So if you want to add an inline image, emoji, link or Math & TeX, you can now search the menu with your keyboard rather than needing to use your cursor or the up/down arrow keys.

Icons for relative links

Relative links — aka links to other pages within your docs — will now display that content’s icon or emoji next to the space/page title in the editor. Before they’d show a space, page or anchor link icon. Now they’ll use the icon you’ve selected for the link target.

A bunch of smaller improvements

• We’ve improved the way that the GitBook editor handles images in image blocks. Now we’ll automatically resized the version that displays within the editor, making the loading times faster and editing smoother. Plus, if you have more than one image in a single image block, you can now drag and drop them horizontally to reorder them.

• We’ve made a few small tweaks to the UI for table and card blocks. Specifically, GitBook now hides the Options menu for blocks within a table or card, so they only appear when you hover near the block. We’ve also changed the padding for the buttons, as they were previously getting cut off within cards.

• We’ve improved tab blocks — specifically linking to specific tabs within a tab block. Before, clicking an anchor link to a tab on the same page would open it in a new browser tab/window. You can also make tab blocks full width, giving you more room if you want to create tabs with lots of tab items or long headings.

• You can now use subscript and superscript formatting options — just highlight your text and choose the new options from the inline palette! So now you can write things like H₂O and 16^th, if you want.

Link tooltips, even more editor improvements, and some bug fixes

Work continues on giving you the best editor experience possible, and we’ve added new tooltips to links in published docs to give readers extra context before they click.

Link tooltips

We’ve added an upgrade to links in published content. You can now hover over any link on your page and after a moment you’ll see a preview of the page, URL or site section it takes you to — making it easier to see the context of the link without clicking it.

Of course, you can open the link as normal by simply clicking. But the new tooltip adds some context if a user isn’t sure whether they want to visit the page.

The tooltip also contains breadcrumbs to show the location of the page in your docs — and these are clickable so you can easily navigate through your content if needed. Plus, there’s a new button in the tooltip that lets users open the link in a new tab.

You’ll also notice a small arrow ↗︎ on external links, to give users an indication that they’ll be taken to an external location on click.

More editor improvements

As part of our ongoing effort to improve and fix some things in the editor, here are some more updates that have shipped this week:

Making images easier to work with

We’ve made a bunch of improvements to the image viewer in the editor. When you click an image, you’ll now see it above the editor — rather than on a black background — helping maintain some context in your browser.

Plus, the Next and Previous buttons that appeared in image galleries properly display as inactive when you reach the end of the gallery. And when you’re viewing an image, click anywhere will now close the viewer.

Finally, if an image shows a Could not load image error, you’ll now see a Select new image button in the image block, to make it easier to replace with an image from the FIles menu.

New card controls

Following on from our recent table improvements, we’ve also brought some of the same improvements to card blocks.

Firstly, for ‘Select’ entries, you can now create new selectable items right from the selection menu — by simply typing your option and choosing Add….

You can also now rename a field’s name from the edit modal, and we’ve improved the spacing in the modal to make it nicer to use. We’ve also fixed the block’s selection border, which was misaligned in a way that we suspect was driving detail-oriented people crazy.

Expandable block improvements

The work to improve expandable blocks continues! You can now add image blocks within expandable blocks, giving you the option add wider images and move images around more easily.

This week we’ve also fixed the formatting keyboard shortcuts, which worked inconsistently while editing text or adding links. They should now work every time. You should also notice that selecting a link will always open the link palette — something that was a little unpredictable before.

New and improved tables, announcement banners, custom fonts and more

Huge table improvements and custom fonts for published sites lead the way this week — which also marks GitBook’s 11th birthday! 🎉

New and improved tables

We’ve completely overhauled table blocks in GitBook to make them more functional and predictable. While they may look similar in the editor, they’ve been totally reworked in the backend to improve performance and make them more practical as a block.

Tables now feature placeholders to make it easier to insert new rows and columns. We’ve also made reordering columns easier when your have wide tables that scroll to show more content.

And, following on from our recent work on card blocks, we’ve also improved the empty states for some cells to make it easier to complete actions, such as adding a file to a files cell.

Plus, if you have a table column using the Select option, you can now add new selection options from the table without opening a modal. Simply type your option and click Add… in the modal.

We’ve also got a new UX for column resizing, and an improved UI for reordering rows and columns by dragging-and-dropping. You can also reorder columns by hitting Enter or Space and then use the arrow keys to reorder them.

Plus we’ve made a bunch of other smaller improvements that improve the usability of tables across the board.

Overall this represents a huge upgrade for tables, making them much easier to use and interact with in the editor. As with any major rework, if you spot anything that’s not working as you expect, reach out to support or report it directly in our GitHub community.

Add announcement banners to published docs

Need to tell users about a product update, time-sensitive announcement or new marketing push? You can now add an announcement banner to the top of your docs site with an icon, text and a link CTA — just like we have right now on this page. Side note: you should fill out the State of Docs survey 😁

Head to our docs to find out how to add a custom announcement banner to your docs — including how to customize their color and icon.

Use custom fonts on your docs site

You can now upload your own custom font for your docs site, so your site accurately matches your brand’s style guide.

Right now GitBook supports .woff and .woff2 file formats. Take a look at to our docs to read more about how to add a custom font to your site. Custom fonts are available for Ultimate sites — head to our pricing page to find out more.

Breadcrumbs in search results

When you use search on a published docs site, you’ll now see breadcrumbs for section groups, sections and variants in the search results. Previously the results would only show one, which could be confusing if the result was in a site variant within a site section.

A ton of editor improvements, bug fixes and more

A dedicated team has been working hard on making some editor improvements and fixes to improve the overall editing experience in GitBook.

A ton of editor upgrades

We’ve had a squad dedicated to improving and fixing some things in the editor for the past week or two. Here’s a quick breakdown of everything they’ve shipped:

Link hover menu improvements

Last week the team redesigned the link hover menu to make it easier to open, edit, copy and remove links from text in the editor. This week they’ve also tweaked the timing for the menu opening and closing. It was previously appearing to quickly and closing too slowly, which could lead to overlaps if several links were hovered in quick succession. The timing has been tweaked to make everything feel slightly better.

Improved menu heights

When you opened the the Insert menu and Options menu near the bottom of a window, the height of the menus was previously quite small. Now, it’ll open at full height, making it easier to scroll and select the option you need.

Toggle the TOC more easily

The Toggle table of contents button is now easier to access. It’ll appear when you hover your cursor over the TOC, and remains visible when the TOC is collapsed making it easier to find again if needed.

Options and dragging for empty blocks

We’ve added the Options button to empty blocks. So now you can easily drag and drop empty blocks around on the page — or open the options menu with a click.

Keyboard navigation out of menus

When you use / or @ in the editor, it opens up a context menu for inline content or an @ mention for another user. Now, you can press the right and left arrow keys on your keyboard to move the cursor around on the page, or hit Esc to close the menu.

Spacing improvements

We made some small tweaks to spacing in the editor, particularly to bring list blocks closer to the paragraph above them — which should make lists following text feel more natural.

A new search bar style, better link editing, plus small improvements and fixes

We’ve added a new way to display your search bar, made it easier to edit or copy links in the editor, and made a big bunch of other improvements and fixes.

Search bar styles for published docs

There are now two search styles available for your published docs — Subtle and Prominent.

Subtle matches our existing style, with a small search bar in the top-right corner of the screen. Prominent moves the search bar to a central location in your site header, and makes the bar itself slightly wider.

You can change your search style in your site’s Customization screen. Head to the Layout tab and you can switch between the two styles using the dropdown in the Header section.

An easier way to edit and manage links

This release brings a better hover menu for links in the editor. The new menu makes it easier to open a link by clicking the URL below the text, and adds buttons to edit, copy and remove the link.

New link styles, broken URL insights, a new integration and more

We’ve added a new customization option, a new way to view external links pointing to nonexistent pages in your docs so you can fix them, and a bunch of smaller improvements and fixes.

Change your link style

You can now switch between two link design styles for your published content — Default or Accent.

Default uses the existing design, with your links highlighted in your primary or tint color. Accent will simply add a colored underline to the link, with the text itself remaining the same color as the rest of your content.

This is the latest design update, following on from the new hint blocks and revamped customization options we’ve released in the last few weeks.

Track URLs generating ‘Page not found’ errors

We’ve added a new Broken URLs section to your site’s Insights page. It shows any incoming links from external sources that are resulting in a ‘Page not found’ error. These may be incorrectly-inputted URLs, outdated links with no redirects, or spam links.

You can combine this with site redirects to point people looking for information in the right direction.

And if you want to check the source of the broken URLs, you can head to the main Traffic insight section, filter by ‘Page: not found’ and scroll down to the Referrers section to see the source of the links.

New Gurubase integration

We’ve just added Gurubase to our list of GitBook integrations — so you can now add an AI-powered Gurubase chat widget to your documentation. The integration enables real-time AI assistance for your readers directly within your documentation pages.

New and improved hint blocks

You can now add titles to hint blocks and customize their colors for published content, plus we’ve released a number of other smaller improvements.

New hint block design and colors

We’re redesigned our hint blocks to give you more options when creating your docs.

The new blocks now use a smaller font size, and you have the option to add headings to them, which will appear in a colored bar at the top of the hint. To do this, simply add a heading block as the first block inside the hint block.

If you’re publishing your content on a docs site, you can also customize the colors of your hint blocks however you like. To do this, head to your site’s Customization menu and scroll down in the General tab until you see Semantic colors.

Here, you can set the colors for Info, Success, Warning and Danger. Once you hit Save, the hint blocks in your published content will update with those chosen colors.

Powerful new themes, site section groups and more

We’ve added some incredible new customization options for your docs site, including new theming options and site section groups that let you create a nav with drop-down menus.

New themes to modernize your docs site

We’ve just released a new set of themes that make it easier to design an incredible-looking, branded docs site ✨

These are different from the old themes as they apply to the whole site — from the background and header, down to individual elements and icons.

There are four new themes

• Clean – A modern theme featuring translucency and minimally-styled elements. Clean is available for all sites, and is the new default theme.

• Muted – A sophisticated theme with decreased contrast between elements. Muted is available for all sites. If your site previously used the Default header theme with background tinting enabled, it will now use this theme.

• Bold – A high-impact theme with prominent colors and strong contrasts. Bold is available on Premium sites. If your site used the Bold, Contrast or Custom header themes, it will now use this theme.

• Gradient – A trendsetting theme featuring a gradient background and splashes of color. Gradient is available on Premium sites, and is completely new!

These four themes can be combined with any of our other customization options — such as tints, sidebar and list styles, corner styles, and more.

The updated Customization menu also makes it easy to add a tint that compliments your theme perfectly. You’ll see some suggested colors based on your primary color selection, and you can select one with a click to preview it in the menu. You can also simply select your primary color as your tint, or a completely custom color — the choice is yours.

Head into your docs site’s Customization menu to explore your options, and head to our docs to find out more.

Create more structure with site section groups

A few months ago we announced site sections — a new way to add content from multiple spaces to a single site, with tabs along the top to switch between each section.

Today, we’re building on top of that with section groups. As the name suggestions, section groups let you group up a number of sections in a drop-down menu that appears next to other sections in that top bar.

That means you can create a top navigation bar with clickable groups and drop-down menus containing links to other pages, right in your docs site.

You can give your section group a name and icon, and even add descriptions to the sections within them — which will appear below them in the menu — if you want.

You can manage all of this from your site’s Settings tab, in the Structure section.

An all-new preview, better OpenAPI blocks and more

We’ve given your site preview a big upgrade with extra options, improved our OpenAPI blocks, added some new integrations, and more.

A new way to preview your site

You can now use the Preview tab in a change request or your site’s dashboard to see how your site looks with the changes you’ve applied.

It also lets you easily switch between the light and dark mode of your site, and also view it on desktop and mobile sized viewports — all in one place.

Improved OpenAPI blocks

We’ve updated the design of OpenAPI blocks in GitBook. They’re now cleaner and easier to navigate, with a refreshed design. We’ve also improved the appearance of the Test it section, to make it clearer and more obvious in the interface.

This is just the first improvement in a bunch of upcoming improvements to API documentation in GitBook. Stay tuned — we’ll have more to share soon.

New Hexus and letmeexplain integrations

We’ve just released new Hexus and letmeexplain integrations in GitBook.

The Hexus integration lets you embed interactive Hexus product demos, walkthroughs, and how-to guides directly into your Gitbook pages for easy access and visualization.

Meanwhile, the letmeexplain integration allows you to display the letmeexplain chat widget on your public documentation to connect and interact with your readers.

Completely revamped insights, a better header bar and more

We just shipped a huge improvement to your site insights, along with a new header bar to make space and site management easier.

A huge upgrade for site insights

We’ve just shipped an enormous update for site insights. It now offers a lot more data points, new visualizations, and a whole new section to make it easier than ever to track your docs site’s effectiveness.

First, insights now live in their own dedicated tab in your site’s dashboard. You can see a top-level overview of your insights on your main dashboard page, with a globe that shows recent views in the last hour by location.

Click into the Insights tab and you’ll get tons more information about your site analytics. You can see traffic, popular pages, user feedback, search and Ask AI data, and data about how users are using any OpenAPI endpoints you’ve added to your docs.

You’ll see a graph on each page to visualize the data, and can add filters or group your data to view specific ways. For example, you could look at search data for a specific site section, or filter your traffic data by country, device, browser and more.

By combining these filters and groups, you can drill down in to precise analytics data to track the events that you are important to you. And because our insights data is on-site, straight from the source, they’re incredibly accurate.

The new insights are available now — although the Links and OpenAPI sections are only available on Premium and Ultimate sites.

An all new space and site header

You probably noticed that the header bar in the GitBook app has changed this week, with new features and a more compact design.

The new header combines the old header and sub-nav bars into one, and makes it easier to switch between different functions whether you’re in a space or managing your docs sites. The bar’s layout stays consistent across spaces, change requests and sites — while individual controls will change to show what’s relevant.

Tabs make it easy to switch between different views, which is particularly useful in change requests — where you can quickly view changes or preview your edited content. It’s also great in your docs site dashboard, as it makes it easier than ever to switch between customizations, insights, settings and more.

Improved site colors and tints

We’ve just released a substantial change to the way we generate color palettes in docs sites:

• A better color palette based on your chosen colors We now define color in terms of perceived LCH instead of RGB values. And we assign a function to each of the shades in the palette, so colors are used more consistently and always work well with each other.

• Better color accessibility – Thanks to guaranteed accessible color contrasts, your colors will be more accessible no matter which values you use.

• An upgrade for tint color – When enabled, the tint color of your site now tints every single element on the page, rather than just the background.

You may notice some small visual changes across your site, but they will be minimal. If you have enabled the new Tint setting in your site’s Customization section and selected a strong primary color, you’ll see a more pronounced change. You can see the changes on your site right now.

• If you enjoy the bold look, then set (or keep) your tint color to your primary color or another strong color. We’ll mix in that color everywhere and it’ll stay vibrant in places where it can be.

• If you’d rather tone it down a little, then try setting your tint color to a desaturated shade. It’ll contrast with your primary color in a more subtle way.

/llms.txt support, improved sitemapping and more

All GitBook sites now automatically generate an /llms.txt file to make it easier for large language models to process your site data.

llms.txt support for published content

We’ve just added support for /llms.txt for your published docs. That means that GitBook will now automatically generate and host a plain text version of your docs, to make it easier for large language models to process.

You can find this file by simply adding /llms.txt at the end of your docs site’s URL. For example, you can check out the version generated for our docs at https://gitbook.com/docs/llms.txt.

This follows a proposition from Jeremy Howard, Co-founder of Answer.AI, to use the llms.txt file format as a standard to help LLMs gather information from a website at inference time, without needing to parse HTML, JavaScript or ads.

Improved sitemap support

We’ve improved our sitemap support for your published site. Now, all indexable pages in your site are listed in the sourcemap, with one sitemap for each published space. That means all your site sections and variants include all the pages within them in the sitemap.

A better site footer, clearer cards, keyboard formatting and more

This week we’ve made visual improvements to your site’s footer, added placeholders to empty card fields, add keyboard formatting options, and more.

Footer improvements

We’ve shipped a number of improvements to the footer, which all add up to a cleaner and more adaptive look for the bottom of your page.

• The footer now allows for more than four groups of links, so you’ll soon be able to add many more groups and GitBook will automatically organize them in a neat grid.

• We’ve increase the footer logo size to allow for wider logos. If your site already used a wider logo, you’ll notice that it now displays larger and fits better on the page.

• We’ve also improved the layout of the footer, so that your links and the copyright notice align perfectly with your page content.

These changes are all live now, and your site footer should have updated automatically.

More card improvements

We’ve been making a number of improvements to cards over the last few weeks, and that continues this week. Here are the latest updates:

• You’ll now see placeholders on any card with empty text and number fields to show that data is needed in those slots. Other empty card elements also now show buttons that prompt you to add links, files, users or a multi-selection with a click.

• We’ve also improved the alert tooltip that appears when you insert a non-numeric value into a number field. It’ll simply notify you that the content of the field needs to be a number.

• We’ve update the default content of a card block. Previously new card blocks featured three cards, each with three empty fields. We’ve updated this, so the default for a card block to be one card with one line of text, and a placeholder next to it to add more.

Keyboard formatting in the GitBook app

You can now add keyboard formatting to any text in GitBook — perfect for writing keyboard shortcuts in your docs. For example, you could tell people that they can hit ⌘+/ or Ctrl+/ to open a block’s Options menu in GitBook, if you really wanted to.

To add keyboard formatting, highlight the text you want to format and choose the Keyboard option from the inline palette.

Easily revert site customization overrides

When you’re customizing a docs site with multiple site sections or variants, you can easily set site-wide customizations. But you can also override customization settings for specific sections or variants, if you want.

Previously, once you changed something at a section or variant level that override couldn’t be reset. Now, we’ve added a button that let’s you reset any overrides back to the site-wide settings, so you can quickly align all your site spaces once again.

A big upgrade for docs site TOCs, plus better tables and emojis

We’ve added more customization options for the table of contents, plus a new alignment setting for tables and an emoji update in the GitBook app.

Big upgrades for your docs site’s table of contents

Today we’ve released a number of new customization options and improvements to TOCs in published documentation. Here’s what’s new:

• Background styles – You can now select the new Filled table of contents style to visually separate your navigation from your content. It will automatically adapt to your site’s background color for both light and dark mode. The default style remains the same for all sites.

• List styles – Change the style of list items in both the TOC and the On this page section on the right. Use Pill for a cleaner look, or Line to appear more technical. The default style remains the same for all sites, but as the On this page section now uses the same style, it might look slightly different from what you’re used to.

• Vertical site sections – If you have disabled the header on your site but you’ve created multiple site sections, those sections will now be displayed as a vertical list at the top of the table of contents. When there are more than five sections, the list will scroll. The horizontal tabs remain the default for all sites with a header, although vertical sections will be an option for all sites in the future.

• Moved variant dropdown – With all the changes above, the variant dropdown felt more at home at the top of the table of contents. We made sure that its behaviour is as close to the current behaviour — it remains sticky at the top of the TOC, so is always available. If you have variants on your site, you should see the variant selector in its new position already.

Vertical alignment in tables

You could already set the horizontal alignment of cells in table blocks — and now you can also set vertical alignment per column. Hover over the column header and open the Options menu , then choose Vertical alignment and the alignment you want.

In-app emoji update

We’ve now updated our emoji within the GitBook app to display as Apple Emoji on Apple devices, and Google’s Noto Color Emoji for non-Apple devices.

This follows last week’s update to change the same emoji for published content to make them more accessible across all browsers.

Ask AI insights, TOC improvements, an emoji update and more

You can now see insights into what your users are asking in your docs, we’ve made some small improvements to the table of contents, and fixed a few bugs.

Ask AI insights

You can now see insights for the way that your site visitors are using Ask AI in your docs. It’ll show the most popular questions that users are asking, so you can analyze popular topics and write more content to address them if needed.

You’ll find the tool in your site’s dashboard with your other site insights. Scroll down to the bottom of your dashboard to see them on the left-hand side.

In-app table of contents improvements

We’ve made a number of small improvements to the table of contents in the editor to make it easier to work with pages in your space:

• Reduced the opacity of pages as you drag them to make it easier to see the content behind them.

• Increased the size of the drop zone when you drag and drop pages to make it easier to move them to the right place.

• Reduced the size of and moved the Add page + button that appears when you hover between pages button to the left of the line, so they don’t obstruct any page titles

More familiar emojis

We’ve updated the emojis in published content. They’ll now display as Apple Emoji on Apple devices, and Google’s Noto Color Emoji if the user is not on an Apple device.

Our previous emoji library wasn’t accessible across all browsers, so we’ve switched them to give your users a more consistent experience.

We’ll soon update the emojis within the app to use these same sets so you can see an accurate representation of your published content.

Visual upgrades, table improvements and more

We’ve made some visual upgrades to published docs sites, added content breadcrumbs, made tables more consistent, and added new ways to style text in comments.

Visual upgrades for docs sites

This week, we’ve released a few visual improvements for docs sites.

First, the Tint color customization option now has more choices. Set it to Primary and the background of your docs site will subtly tint to match your primary theme color. Alternatively, choose Custom to select a different color to use as the background, and across your site — such as in tables (more about tables below).

Your site header also now has a more modern look. It now features translucency, a new search bar, an a more flexible layout across screen sizes — especially on small and tiny screens.

Finally, we’ve updated the link styles of the footer to match those of pages and groups, to give a more consistent look and feel.

Site-level breadcrumbs

You may have noticed that we now show breadcrumbs at the top of your pages in GitBook. By default it will show the page group title, but for nested pages it will also show the parent pages, including their page icon or emoji. You can click any of the breadcrumbs to jump to that page or the top of the group.

More consistent tables

This week we’ve released a bunch of improvements to tables to make them more consistent.

• First, tables that are smaller than the page will now appear at the same width when published — rather than increasing it to the width of the block as it did before.

• Likewise, if you set custom column widths by dragging the separator, this will now be respected in the published site.

• We also know that text-wrapping in cells was too aggressive, so we’ve fixed that to make better use of available space.

• On top of that, we’ve updated table styles for published content. The table header will now adopt your tint color — if you’ve enabled it in your site’s Customization screen — and it’ll also respect your selected corner style.

Bold, italic, code and lists in comments

You can now use Markdown to apply styling to text in comments. As well as bold, italic and code styling, you can also create bulleted and numbered lists in comments. Plus, we made pasted URLs clickable in comments so you can open them more easily.

Our own docs just got better

We’ve spent the last few weeks improving our own docs with new information, improved images, and more details to help you find the information you need faster.

You might also have noticed a couple of new site sections at the top of this page — Guides and Help Center. Guides includes a range of tutorials and advice to help you make your docs the best they can be in GitBook, and Help Center is there to answer your questions and solve issues as you run into them.

Take a look around — we hope you like the changes we’ve made. We’ll be adding to these sections regularly going forward, so stay tuned for more!

Ask AI improvements, a better inline code experience and more

With this release your users can now get AI-powered answers from across all the sections of your docs site, plus we’ve improved inline code blocks, upgraded the page outline, and more.

Ask AI for all your public docs

When we released site sections in October, we announced that it also unlocked site-wide search for all your content. Now, we’ve also unlocked Ask AI for public docs, so when you or one of your users asks a question in your published docs, it will pull from sources across all your site sections.

Upgraded page outline

The page outline of the right-hand side of the screen has had an upgrade. It’s now faster than ever to jump between sections on the page with a click, and the highlighted bar on the left of the outline shows all visible sections, so it’s easy to see all the sections that are currently in view.

A better inline code experience

You can now use backticks to create and close a code block when writing code inline in the editor. Plus, when you are writing in a code block, you can now press the right arrow key to exit it and return to writing standard paragraph text.

Add a header drop-down without a link

Want to add a drop-down menu to your docs site without linking the menu button itself? Now you can. Simply leave the link section blank in any header link with sub-links and it will act purely as a hover-activated menu.

Improved cards

You’ll now see a cover image placeholder in empty cards, making it easier to add header images to all your cards. Plus, we’ve made it easier to add new fields to a card with a button at the bottom of each one.

Icons for site sections

You can now add icons to the site section tabs along the top of your docs, making it easier for your site visitors to navigate around your content and find what they need faster.

To enable them for your site, head to Site settings, select the Structure tab, and you can add icons to your sections using the table.

Site redirects, better site structure controls and more

Get more control over URLs, manage your site’s structure more easily, install integrations more easily, and auto-play and loop embedded videos in your docs effortlessly.

More control over site redirects

Want to migrate content into GitBook, or just have a big reorganization? With the new site redirect options, you now have more control over where your old URLs point to. Open your site’s dashboard and open Settings to find the new controls.

GitBook already sets up HTTP 301 redirects if you move or rename a page, so that the old URL points to the new URL automatically. But you can now create a redirect from any path in your site's domain — which is important to avoid broken links in your docs which could impact SEO.

Head to our docs to find out more about site redirects.

Integration improvements

We’ve given our integrations flow a big overhaul to make it easier to browse, install and configure integrations across all your content. Just click Integrations in the sidebar to head into the new page, where you’ll be able to see all available integrations and install them with one click.

There’s also a new Integrations button for spaces and sites, which opens a modal showing just the integrations enabled on that space or site. You can click to configure the ones you need or see more details about them, or install any others that you need.

Improved site structure controls

Last month we launched site sections, giving you all the tools to build your docs out into a content hub for your users. This month, we’ve improved the site structure controls to make it easier to manage your site sections and any variants within them.

We’ve also tweaked the way you rename variants — now, you can only do it from the site structure table, and the option is no longer available in the Customization menu.

Head to your site’s dashboard and open Settings to see the new table and test it out.

A new option to auto-play and loop videos

Want your embedded YouTube and Vimeo videos to auto-play and loop in your docs? Just add ?autoplay=1&_loop=1 to the end of your video’s URL when you embed it and your users will never have to hit a play button again — at least in your docs.

Type symbols faster

We’ve added automatic transformations for more symbols in the editor. You can now add an em-dash by typing -- , fractions by typing, for example, 1/2 and math symbols such as ⇒ ≥ and ≠ by typing =>, >= and != respectively.

Site sections with global search, sponsored docs for open source and more

Make your docs a content hub with site sections, create and reuse content across a space, add buttons to your site header, use stepper blocks in your content, and even more.

Site sections

You can now add multiple topics, such as separate products or product areas, to a single docs site, and separates them into tabbed sections at the top of the screen, to turn your docs into a content hub. [Site sections]https://gitbook.com/docs/publishing-documentation/site-structure/site-sections) are available as part of our new Ultimate plan.

Global site search

When you add multiple spaces to a site using site sections, it also unlocks global search across all those spaces. So your users can use the search bar in your site header and find pages and information from any space with a single search.

Add buttons to your site header

Now, you can add primary and secondary buttons to your docs site’s header, along with the links you could add before. Head into the Customization menu for your site, choose the Layout tab, then add the buttons you need. This is great for things like ‘sign up’ and ‘sign in’ links, for example.

Stepper blocks

We’ve added a new kind of block that’s designed for detailing step-by-step guides — the stepper block. You can add steppers to any page, and add almost any other block within a step.

Improved insights

We’ve given our built-in docs site insights a small facelift. You’ll now see some data trends on each card to show how your content performance has changed over the last week, four weeks, or year — right on your docs site’s overview page. We have more insights improvements to come soon, so stay tuned!

Reusable content

We’re continuing to roll out reusable content — our new name for synced blocks. You can now create and reuse blocks of content across a space. When you edit the original content, those changes sync across all of its instances — making it easy to update published docs faster than ever.

Sponsored sites for open source

Today, we’re announcing a new free docs site plan that’s designed specifically for open source projects. The Sponsored site has all the features you need to publish incredible documentation, including customization, data insights and integrations. It puts a small, relevant ad in the corner of your project’s docs — every view earns you money and you keep the ad revenue. The ads will never track or retarget users — and GitBook doesn’t take a penny from you. Find out all about it in our announcement post.

Copy and paste files between spaces

Now, when you copy any block that includes a file — such as an image or an API block — and paste in a new space, the file will come along with you. We know this is something you’ve been asking about for a while, and we’re glad we could make it happen without compromizing on GitBook’s file management experience.

New pricing for new users

We’re updating our pricing for new users to cover different needs and use cases. Our new pricing structure introduces site plans, which apply to each site you publish. Right now these changes only apply to new customers or new organizations. Head over to our pricing page to see our new plans and how they stack up.

Want to hear more about everything we announced this week? Head to our blog to see all the announcements, teases and reflections on the future of documentation in GitBook.

Improved diff view, synced blocks and more

We’re adding reusable content to GitBook, along with a better way to view edits in a change request, improved change request previews, and more.

Synced blocks

We’re slowly rolling out a new way for you to create and reuse blocks across all your content in GitBook — synced blocks.

Create a synced block by selecting and copying it, then add it to other pages from the insert menu. When you update it one place, those changes sync across all instances, making it easy to update published and internal docs faster than ever.

You can view, edit and manage all your synced blocks from a new section at the top of the sidebar.

Synced blocks will be available to everyone on a Pro and Enterprise plan soon.

Better diff view

This update brings an improved diff view, with a new option to only show edited pages in the table of contents. So if you prefer, you can easily browse changes without scrolling past other pages with no edits.

We’ve also changed the design of diff view to be more in line with other tools that use diffs. Modified blocks are now highlighted with a colored line, and text is highlighted using a background color rather than a text color to make edits clearer.

Finally, you can now add comments to individual blocks when viewing content with diff view enabled. This should make it easier to review content and add feedback without switching between view modes.

Insert integrations faster

We’ve updated the insert pallet to include installed integrations for the space you’re editing. Now, when you hit / on an empty line, you can scroll or search through the palette and see block integrations that are already installed on the space, making it easier than ever to add them to your content.

URLs for multi-variant docs sites are changing

We’re changing the structure of URLs for sites with multiple variants — and we’ve set up automatic redirects to ensure all links still work as expected.

What’s changing?

This Thursday, 26 September, we’re releasing a change that will change the URL structure for multi-variant docs sites — i.e. published sites with more than one linked space.

If you’ve published multiple spaces in the same site, you might’ve noticed that variant URLs have a /v/ between the domain and the slug. This update will remove that to simplify the URL for your readers, and make it easier for people moving their existing published into GitBook.

The result will be that a URL such as docs.mycompany.com/v/fr/ will now be accessible at docs.mycompany.com/fr/ .

All depreciated URLs (e.g. docs.mycompany.com/v/fr/ ) will automatically redirect to the new canonical URLs.

What does this mean for your content?

In most cases, this should not be a breaking change — you may not even notice it’s happened. The old URLs will still work by redirecting to the new URL.

However, if you’ve set up some custom logic with there URLs, this change may require you to update your setup.

We’re proactively reaching out to customers who we know may be affected by this. But if you have any questions about your custom setup and how this change may affect it, please reach out to our support team — they’d be happy to help.

Page index controls, better OpenAPI blocks and more

You can now exclude specific pages from searching indexing — for both in-app search and external search engines.

✨ New

• Prevent page indexing – We’ve added a new control in Page options that lets you disable indexing for a specific page. This will opt that page out of in-app content searches, as well as indexing by search engines like Google, Bing, etc. When combined with the Hide page option we introduced last month, it’s great for depreciated pages that should still be accessible via URL or the table of contents, or for special pages such as changelog entries, that you don’t want to be indexed by Google but should be accessible to users.

• A new share modal – We’ve improved the layout and structure of the share model within GitBook. It’s now split into two clear tabs — one for inviting organization members to the internal version of the page, and another for publishing the page to the web using a docs site.

• A better trial process – We’re slowly rolling out an improved trial process that makes it clearer when a trial has started and what you can test while it’s running. And, at the end of your trial, you’ll be able to easily choose whether to keep the features of the Pro plan, or downgrade back to the Free plan.

➕ Improved

• We’ve updated our OpenAPI blocks to use the latest version of Scalar. It means faster performance and a better experience when using OpenAPI docs in published documentation. We now also handle some extra aspects of the OpenAPI schema, including mandatory headers and examples with multiple status codes.

• We’ve added Dutch localization support, so you can now set the language of your public documentation UI to Nederlands. Head to your site’s customization settings to update the locale for your docs. A big thank you to Rens Reinders for the hard work on this translation. Check out our open source repository if you want to add your own localization!

• Our code blocks now support Python, plus we’ve improved syntax highlighting within them and fixed some issues with diffs.

🔧 Fixed

• Fixed the SAML configuration modal, which was taking up the full width of the browser window.

• Fixed a bug that would redirect a site’s share links to an internal URL if the site had a custom domain enabled.

• Fixed a bug that prompted you to save changes whenever you switched between tabs in the Customization menu.

• Fixed an issue that meant when deleting a collection, the Cancel button in the confirmation modal wasn’t clickable.

• Fixed a bug that made it impossible to edit the title of a change request if the field was cleared.

• Fixed an issue that removed the Diff view option from a merged change request.

• Fixed an issue where searching for members in Members table would reload the entire page, instead of just the table.

A new space header, bug fixes, and a bunch of smaller improvements

We’ve just released a new space header to make it easier to manage your content, plus a whole host of other smaller changes to improve your experience in GitBook.

✨ New

• This release includes a new space header, which makes it easier to navigate through your content, manage your content and edit in a change request. As well as moving a few things into easier-to-reach places and decluttering the header, we’ve added breadcrumbs for your current content at the top of the screen, so you can navigate back to other parent pages and collections with a single click. Plus, the space header now aligned nicely with side panels to make a seamless experience — which our design team are particularly happy about.

➕ Improved

• You’ll see some nice improvements to the Settings section of the app — particularly the team settings, which now has a better structure that’s more consistent with other settings sections. The lists in the Members and Teams sections also got an upgrade, making it easier to select individual users, and sort by ‘last seen’.

• We’ve added an Actions menu button to each change request in the Change Requests side panel — so it’s easy to archive old ones quickly without having to open each one individually.

• We’ve made a bunch of small improvements to the broken links side panel to make it easier to find and view broken links in your pages. Also, users on the Free and Plus plans can now see one broken link preview in the broken links side panel, so it’s clearer how the feature works and what the icon alert means.

• When you expand or collapse the docs site and spaces sections in the sidebar, GitBook will now remember the setting the next time you open the app — so you can always see exactly what you want, when you want. Plus, jumping to a specific space or docs site will automatically expand the relevant section in the sidebar so you can see it in context.

• You can now filter docs sites by ‘Published’ and ‘Unpublished’ in the sites list, to see only the sites you want. We’ve also added pagination to the list, so you can jump through them more easily if you have a large number of sites.

• We’ve also improved the SSO settings section. Now, you can configure a default team for each SSO provider. So if, for example, you want everyone who signs in with OneLogin to automatically be added to the Engineering team in GitBook, you can do that with a click — along with setting their default role. There’s also a link to our SSO documentation in the UI, so if you need help getting set up you can quickly get some answers.

🔧 Fixed

• Fixed a bug that stopped images being directly inserted into a page when you dragged them into GitBook to upload and add them.

• Fixed the spacing at the bottom of the site settings screen.

• Fixed an issue with organization invite links that could show an error to people trying to join your organization using a legitimate invite link.

• Fixed a bug that prevented some blocks from being switched back to normal width from full width.

• Fixed a crash that could sometimes happen when trying to delete a page.

Page icons, docs site improvements, hidden pages and more

We’ve added new icon options for your pages, made a bunch of improvements to docs sites, made hidden pages and MFA available for everyone, and much more.

✨ New

• You can now choose from a set of 3,600 icons to add to your GitBook pages, to help you add more context to your table of contents. It’s added to the picker when you click next to your page title, alongside emojis. Plus, the picker now remembered your more recently used options so you can quickly add them again. For icons on published pages, you can also change the icon style from the Customization menu from five options.

• We’ve improved your docs site’s home screen, with a new header that shows all the useful information you need about your site and some handy links to edit your content or change your settings.

• We’ve added a new flow for creating a docs site — you’ll now be guided through naming your site and choosing between an empty site or some sample content, before you choose whether to publish. It’s designed to get your site set up quickly and is great for new users. And just try clicking the icon on the preview to the right for a little easter egg 😉

• As part of our ongoing UI improvements, this release makes it easier to navigate around GitBook. The sidebar has new buttons and a neater layout to make it easier to select and expand different sections. You’ll also see improvements in the Settings page, and a few other smaller improvements and fixes around the whole app.

• Last month, we told you we were slowly rolling out multi-factor authentication. Now, we’re pleased to confirm that MFA is available for everyone who wants to use it.

• Likewise, the option to hide pages from a space is also available to everyone now. Take a look at our previous changelog update to find out more.

➕ Improved

• GitBook will now remember how you logged in last time, and suggest it next time you need to log in — just in case you forget whether you signed up with GitHub, Google or an email.

• When you sign up to GitBook, we’ll now ask you what you want to use it for and offer you relevant options based on that choice.

• We’ve made a number of UX improvements and bug fixes to improve the performance of the files manager. As well as better sorting options and better page switching, you'll also notice that you can click the file preview to open a zoomed version of the file, and click the file to open the actions menu.

🔧 Fixed

• Fixed an issue that caused the app to crash when a referenced snippet no longer exists.

• Fixed an issue that meant links to other published content inside a docs site variant had the wrong URL.

• Fixed a bug that prevented you from deleting a block in some situations.

• Fixed an issue that meant you could create multiple change requests by clicking quickly on the Edit or New change request buttons.

• Fixed an issue with share links in docs sites — viewing the share links for a site would crash the app if there were more than 10 links.

• Fixed a number of visual layouts on mobile, including breadcrumbs, docs site list, insights, and more.

• Fixed an issue that meant when you opened the revision history for a page, it could break navigation on other side panels, such as comments.

• Fixed a layout issue in the notifications menu that would push the text too close to a user’s avatar.

• Fixed an issue that meant resolving conflicts could revert back to their conflicting state.

Docs sites rollout introduces new publishing flow in the GitBook API

With the introduction of docs sites, several older API endpoints for publishing, share-links, and authenticated access have been deprecated.

💥 Breaking changes

With the release of docs sites, certain API endpoints for publishing, share-links, and authenticated access have been deprecated and may no longer function as expected. If you’re affected by this, we recommend the following approach to make the necessary updates:

To modify or retrieve publishing states, share links, or authenticated access settings for a space, locate the associated site and copy its ID. Click the globe icon at the top of the space’s screen to open the site, then copy the Site ID from the URL.

Publishing

PATCH /spaces/{spaceId} to change the visibility or published state of the space now requires the following changes:

• PATCH /orgs/{organizationId}/sites/{siteId} to change the visibility of the site.

• POST /orgs/{organizationId}/sites/{siteId}/publish in order to publish the site and POST /orgs/{organizationId}/sites/{siteId}/unpublish to unpublish the site.

Share links

/spaces/{spaceId}/share-links and /spaces/{spaceId}/share-links/{shareLinkId} now requires you to use /orgs/{organizationId}/sites/{siteId}/share-links and /orgs/{organizationId}/sites/{siteId}/share-links/{shareLinkId}respectively.

Authenticated access (publishing auth)

/spaces/{spaceId}/publishing/auth methods should now be used through /orgs/{organizationId}/sites/{siteId}/publishing/auth

Rolling out MFA and the hidden pages beta

This release lets you make your account more secure, adds a beta option to hide pages from published sites, and includes a bunch of other, smaller improvements.

✨ New

• We’ve added a new option to hide pages from the table of contents in your published sites — available right now in closed beta. Your users can still access hidden pages via direct link, find them through an on-site search or by asking GitBook AI — and they’re indexed by search engines. This is ideal for content such as FAQs that you don’t want taking up space in your TOC, but you still want people to access if needed. Members of our closed beta can enable hidden pages in the Experimental features section of their organization settings.

• We’re improving the security of your GitBook account by adding the option to use multi-factor authentication (MFA) to sign in. We’ve started slowly rolling it to GitBook users, and we’re testing it carefully as we go. Right now, MFA in GitBook supports authenticator apps such as Google Authenticator and 1Password.

➕ Improved

• We’ve moved the social preview and page rating options out of the Customization menu and into the site settings, so they’re easier to find and change.

• You can now give your docs sites longer names, as we’ve incresed the site title length to 128 characters.

• Importing content from GitSync now infers the table of contents from files more effectively by removing common prefixes.

• We’ve tweaked the size, position and margins of some of our modals to make them fit better on smaller screens, tweaked the position of the search menu, and made a bunch of other small improvements to the look and feel of the app.

• You can now set Guest as the default role in your organization settings, to make adding guest users easier than ever.

🔧 Fixed

• Fixed a bug that prevented you from resetting the privacy policy URL in the customization settings of a published space or site.

• Fixed an issue where changing your trademark on a site wouldn’t show in the customization preview.

• Fixed a bug that was causing the custom domain modal to close unexpectedly after the second step.

• Fixed an issue that could prevent members with Editor permissions couldn’t merge a change request in a space.

• Fixed an issue where page ratings sometimes showed negatively-scoring pages in the ‘Good’ table.

• Fixed a bug that prevented you from typing anything in the text area when you added a link to a card block

• Fixed a bug that caused the organization switcher button to sometimes require more than one click to open.

New localizations, docs site improvements and more

Support for Brazilian Portuguese and German, a new way to manage and install integrations, and a whole bunch of docs site improvements.

✨ New

• We’ve added Brazilian Portuguese and German localization support to GitBook, so you can now use the GitBook app in more languages. Head to your site's customization settings to update the locale for your docs. Huge thanks to Rodrigo Castro and David Burghoff for their hard work on these translations — and their contributions to our open source repository.

• Integrations now live in their own page, accessible through the sidebar. You can view them by category, see which integrations are enabled for specific spaces, and install new integrations — all from the same screen.

• We made a bunch of smaller improvements to the docs sites dashboard, site settings, and the publishing flow in general. And we’re not done! You’ll see more in the coming weeks as we make it the best it can be.

➕ Improved

• We’ve made some big improvements to the way you set up custom domains for published content. You won’t see an error if you have a custom domain set up and try to edit it, and the button to edit it now takes you right to the DNS settings — and it’s contextual, based on the state of your domain. We’ve also improved the alerts and the general setup flow to be clearer about what you need to do.

• We’ve changed a lot of the wording in the publishing flow for docs sites to make it clearer when your content will or will not be indexed by search engines, and when share links are active or inactive.

• You’ll also notice improved wording when GitBook AI cannot find an answer to your query, and it’ll suggest some related spaces based on your question.

• When you open the Share modal from a space, you can now click Publishing to access your publishing options using docs sites.

• You can now quickly visit your published docs site from the Actions menu in the sidebar. Just open the menu and choose Visit site.

• We’ve improved our toasts — you can now close them, and they’ll stack behind each other to prevent them taking up too much of your screen if you have multiple triggering at the same time.

🔧 Fixed

• Fixed an issue that stopped the Rollback button working properly when browsing a space’s history.

• Fixed an issue that prevented SAML providers being added or updated.

• Fixed a bug that meant clicking the Options button in cards and other elements would select the element itself rather than opening the palette or menu.

• Fixed an issue where collections in the sidebar could appear highlighted after being opened or closed.

• Fixed some incorrectly-implemented prefers-reduced-motion checks, and added more checks so those users wont see animations in the UI.

• Fixed a bug that meant pressing Esc when a modal was open wouldn’t close it.

• Fixed an issue that stopped a custom domain from displaying immediately after you set it up. It’ll now update in the GitBook UI right away.

Introducing docs sites, the new way to publish content in GitBook

We’ve revamped the way you publish content in GitBook by bringing all your published content together, along with all the settings and features related to publishing.

✨ New

• Docs sites in the sidebar – You’ll now see a new Docs sites section of the sidebar. Here, you can view all your published content in one place, quickly move between different sites, and manage each site individually.

• Insights have a new home – Insights now live in the Docs site area, right alongside each site. This makes it much easier to find insights for the content you want. Simply select a site, then click the Insights tab to view page ratings and search analytics for that site’s content.

• Publish the same space on multiple sites – If you need to publish different combinations of spaces for different user groups, you can now do it effortlessly. Link a single space to as many sites as you want — you can even customize them all differently to match branding or styling requirements.

• You can read about all these updates and learn more about docs sites in our documentation preview.

➕ Improved

• We now automatically enable GitBook AI features (including search and editing) when you create or upgrade an organization on the Pro plan, so you can immediately start making the most of your plan’s features.

• We’re drawing a clearer line between integrations that are dedicated to publishing and those that are focused on editing or adding content to a space. So now, integrations like Google Analytics and Mailchimp will live alongside sites, while integrations like Linear, Mermaid and Supademo will stay with spaces.

GitBook AI gets a GPT-4o upgrade and new diagramming skills

We’ve migrated our AI to use the latest model, so asking questions and generating content will have even better results — plus we’ve added AI diagrams to our drawing tool.

✨ New

• We’ve added GPT-4o to our list of AI models, which means AI search, writing and editing in the GitBook app is now powered by the new and improved GPT model. You should notice faster responses, better understanding of your questions and requests, and an improved output.

• Talking of AI, we’ve just rolled out an update to our drawing tool that can create diagrams from a prompt. Simply describe the diagram you want and hit Generate to get an output in seconds. They’re fully editable, too — so you can dive in and tweak the layout as much as you like. As with our other AI features, this is available to everyone on a Pro or Enterprise plan.

🔧 Fixed

• Fixed an issue where sometimes matching an invalid URL could return a 500 error and crash the app.

• Fixed some accessibility issues to make the app easier to navigate with a keyboard.

• Fixed an issue where the editor would stay in read-only mode even after you disabled diff view in a change request or when viewing an old version of a space.

Broken link detection and GitBook AI comes out of beta

Broken link detection for internal links, AI features are officially graduating, plus some other small but useful updates and bug fixes throughout the app.

✨ New

• Broken link detection – We’ve added a new way to find and fix broken links in your spaces for users on our Pro plan. When you open a change request or edit a space you’ll see a notification that shows broken links. Right now, this shows links to other GitBook pages, but we plan to add more link types in future! Head to our docs to find out more.

• GitBook AI is coming out of beta! – After a long period of testing and improvement, today we’re bringing AI search and AI writing and editing out of beta. They’ll now be available as part of the Pro and Enterprise plans. Head to our docs to learn more about how GitBook AI search and GitBook AI writing can supercharge your content.

➕ Improved

• We’ve improved the rendering speed of drawings in the editor. Your drawing should now appear immediately after you finish editing it, rather than displaying a fallback image while it loads.

🔧 Fixed

Below is a list of bug fixes also included in this release:

• Fixed a bug that stopped some embedded content displaying properly in a published space.

• Fixed an issue that meant content was still editable during operations like merging or updating a change request.

• Fixed an issue that meant some search results had an invalid path, which could lead to broken links.

• Fixed a bug that could cause empty inline Math formulas to prevent Git Sync from working properly.

• Fixed a bug that could delete some content if you had two bullet lists and tried to merge them by hitting enter on the top list.

Small improvements and bug fixes

We’ve made some small but useful improvements to the app, and squashed some pesky bugs as we prep for a bigger release coming soon.

➕ Improved

• You’ll now see a placeholder title and a cursor when you create a new H1, H2 and H3 block to make it easier to visualize how you content will look on the page.

• When you open the Options menu on an ordered, unordered or task list block and choose Delete it will now delete the entire block, not just the content within it.

• You’ll now see a warning if you try to reload your page when your changes haven’t yet automatically saved.

• We’ve improved the way that file columns render in tables within published content, so your files should look great however you display them.

• We now support GitHub-flavored Markdown in OpenAPI specifications, so you can edit your content more easily through Git Sync.

🔧 Fixed

• Fixed a bug that meant the horizontal scrollbar in tables wasn’t usable in some browsers.

• Fixed an issue that could cause the editor to crash when the integrations side panel loaded.

• Fixed various types of OpenAPI schema setups that didn’t parse or displayed incorrectly in published content.

• Fixed a bug that could make diff view persist outside of a change request.

• Fixed a bug that meant anchor links were just linking to the top of the page, rather than the anchor.

• Fixed an issue that caused some images to overflow inside cards in published spaces.

• Fixed a bug which caused the customization preview to be outdated after you hit Save.

• Fixed a bug that prevented page feedback not being captured in some cases.

• Fixed a bug that put the cover image in published content in the wrong position.

• Fixed an issue with integration installation permissions that caused an Install button to appear on already-installed integrations.

• Fixed an issue that caused published pages with a lot of code blocks to crash.

• Fixed an issue that could cause some embedded content to be cut off on the page.

• Fixed a bug that meant searching in a space that was part of a published collection wouldn’t lead to the right URL.

• Fixed an issue that showed the cookie prompt too often for some cookies.

Open-sourcing our published documentation

You can now contribute and suggest improvements to GitBook to make published documentation even better.

✨ New

• We’ve opened our repository for the published documentation side of GitBook, so you can now contribute. Suggest improvements, submit bug fixes, translate the UI into other languages and more — it’s all possible! Head over to our contribution guide to find out more. And if you want to discover more details about this huge development in the way we make GitBook, head to our blog post!

• We’ve partnered with Scalar to add a Test It button to OpenAPI blocks in your published documentation. Clicking Test It will open up an integrated API client, where you can add headers, cookies, variables and more — before sending the request to test your API live.

➕ Improved

• You can now press Tab when using block selection on multiple blocks — such as lists — and they’ll indent one step.

• We’ve added the Export PDF feature to the Actions menu for your internal content, rather than opening the Share modal. This should make exporting a single page or all the pages in a space quicker and easier.

• We’ve improved the loading time for published spaces that include a lot of files — things should now be much speedier.

🔧 Fixed

• Fixed a styling issue for grouped icons in search results.

• Fixed some issues with emoji placement and color bleeding.

• Fixed a bug that removed the hint block when adding an unorganized list and then hitting Enter to start a new block.

• Fixed an issue with text wrapping in tab titles and table cells.

• Fixed an issue with visitor authentication that could occur when setting a token without an expiration time.

• Fixed an issue that prevented the insert palette opening when typing a / in the editor using Firefox.

• Fixed some caching issues with published docs that could cause a long delay before updated content appeared.

• Fixed some issues that were causing unnecessary rate limiting errors and CAPTCHAs for published content.

• Fixed an issue that prevented you from exporting the content of a change request or a previous revision as a PDF.

• Fixed an issue that was causing links between published spaces in published collections to break.

• Fixed some issues that caused some anchor links with upper-case characters to point to the main page URL rather than the section.

• Fixed an issue that could cause the editor to re-render when editing.

Huge improvements to your published documentation

Your published sites are getting a big update, with a new look, better performance, extra customization, improved OpenAPI blocks, a redesigned PDF experience and more.

✨ New

• A new, modern look and feel – Your published now have a more streamlined layout that makes information easier to read. You’ll also notice some neat visual improvements across your docs, such as animated hint icons.

• New customization options – You can now change the background color of your published page. Choose between a plain background, or subtly change the color to match your theme.

• Auto-detect light or dark mode – Your published docs will now automatically detect whether the user’s device is set to light or dark mode, and adjust the theme to match it.

• Multi-space search – You can now also search across multiple published spaces — which is great when you have a published collection and want to let users find information across it all.

• Head to our documentation to see these new features in action!

➕ Improved

• Improved performance – You’ll notice improved loading performance across all your published content. Pages should load faster, feel snappier, and generally give your readers a better experience.

• Better OpenAPI blocks – The new OpenAPI block displays information like sample code to use an endpoint, the shape of a response, and a detailed list of attributes — all based on your API definition. So you can see all the information you need to use the API at a glance, and it’s easy to navigate between response types and languages for sample calls.

• A redesigned PDF export experience – If you allow users to export your published content as a PDF, it’s now faster and easier than ever — and it produces even better results.

• Improved code block syntax highlighting – We’ve improved the way syntax is highlighted in a code block, to make code easier to parse on the page.

• Removed the API method block – As we mentioned in our recent announcement, we’ve deprecated the API method block. Instead, you can now use the insert palette to add the API Reference option, which adds a preset selection of blocks to add API information manually.

🔧 Fixed

• Fixed a bug that caused flickering in the search window when you used AI search.

• Pressing Enter in the title of an expanded block now opens the block. And expandable

• Fixed an issue where some complex emojis were represented by multiple emojis, rather than the single correct emoji.

• Fixed an issue that could make tab headers uneditable.

• Fixed a bug that caused some headers and some avatars to appear too large.

• Fixed a visual bug that occurred when multiple users were on the same page and had the same block selected.

• Fixed a bug in the modal that appeared near the end of the trial that caused text to misalign.

Edit text with AI, a published docs preview and more

We’ve added the option to edit text with AI, a preview of our new published documentation experience, and a bunch of other nice improvements.

✨ New

• You can now edit existing text on your page using GitBook AI. Simply select some text in a block — or multiple blocks — and click Edit with AI then choose the option you want from the menu. It can do things like make your text shorter or longer, simplify language, or even change the tone of your text.

• We have a new published documentation experience coming very soon 👀 and we’d love your feedback. In the next few days, you should see a pop-up that lets you preview your published space with the new experience. And you can always access it later from the New! button in the space’s sub-nav. Give it a try and let us know what you think!

• You can no longer add API method blocks to your documentation. Read our announcement to find out more.

➕ Improved

• We’ve improved the look of the automatic emails that GitBook sends, such as when you log in with a magic link. They now match our new brand styling.

• We’ve made some small improvements to the UI of the Home page to make everything easier to read and understand.

• You can now cancel AI writing while it’s generating if you decide what it’s creating isn’t right for you.

• You can choose to enable or disable all GitBook AI features across your whole organization from the Settings page.

• When you ask GitBook AI a question in the Ask or search bar, the answer will stream for you so you can start reading as soon as it begins to generate.

• When you type ‘Code’ in the insert palette, the code block option will now appear above Codepen in the list so you can easily hit Enter to add a code block. Plus, we’ve moved inline content to the bottom of the insert palette

• When you have multiple people viewing or editing the same space, their avatars will now stack in the top bar and footer to reduce the chance of them pushing other UI elements out of the way.

🔧 Fixed

• Fixed an issue that could lose the most recent edits if you quickly merged a change request.

• Fixed an issue where a tooltip wouldn’t disappear, even after navigating away from the button.

• Fixed an issue where changes to the title and description of a page weren’t saved when hitting Merge.

• Fixed an issue that could cause a crash when deleting a single image in an image block.

• Fixed a bug in the inline link editor that caused the link to overflow the text box.

• Fixed the header for change requests to adapt to any title length and screen width.

• Fixed a crash that could happen when you add a new tab to a tab block.

Deprecating the API method block in favor of OpenAPI improvements

We’re making big improvements to our OpenAPI support and API documentation rendering — so we’re replacing the editable API method block with a standard text alternative.

🖼️ Context and reasoning

Up until now, you could document APIs in GitBook in three different ways:

1. Generating API documentation using an OpenAPI definition

   This is by far the most advanced and flexible method. Teams can rely on their API definition and easily maintain up-to-date API documentation. We support the OpenAPI 3.0 standard to date. Here are a couple of examples:

   • Our own developer docs

   • Bird’s API documentation

2. Craft API documentation using traditional blocks This method gives you full freedom over what to display, and how. While this offers flexibility, you also have to update your documentation manually every time the API changes. Still, some people love documenting their APIs this way!

   • The Mews Connector API docs

3. Manually inserting API method blocks This method gave people control over what they displayed in their docs, but came with some drawbacks:

   • When the source API changed, someone had to update the block manually

   • The way the API method block rendered was inflexible, which didn’t meet our users’ needs

   • The block simply didn’t offer as much information and space as an OpenAPI block

From our perspective, the API method block was very restrictive in what it could support. It also technically limited our ability to improve the OpenAPI documentation experience to the quality we know you expect from GitBook.

📅 Timeline

• Monday 12 February 2024: You’ll no longer be able to insert API method blocks in the GitBook editor.

• Monday 4 March 2024: We’ll automatically transition all pre-existing API method blocks to regular text blocks — read on for more details.

🤖 What happens to your API method blocks?

On Monday 4 March 2024, we’ll automatically change your API method blocks into other, standard blocks. Here’s how an API block will look after the transformation:

We’re confident that the editing and reading experience of translated blocks is going to be improved as a result. That said, we think API documentation is even better using OpenAPI definitions instead of manually written text.

👩‍💻 What’s changing with OpenAPI blocks?

OpenAPI is a standard that helps gather a lot of information about an API and present readers with that information consistently — and automatically. If you use definitions like Swagger, you can easily update the definition file when you update your API, and those changes will instantly sync to your docs, too.

The OpenAPI block improvements that we’re working on right now will show information like sample code to use an endpoint and a detailed list of attributes — all based on your API definition, rather than manual input. It’ll also make it easier to navigate between response types and languages for sample calls and show all the important information at a glance.

We’re testing the updated Open API block in our own developer documentation right now, so head over there to get a sneak peek. We plan to release it on the same day as we depreciate API method blocks, but we’ll share news on that soon.

AI writing assistant, a new home for important updates, and more

We’ve added new ways to create and edit text with AI, plus a new Home section, snippet improvements, and a bunch of bug fixes.

✨ New

• GitBook AI can now help you write content, summarize information, and more — right on your page. Simply start a new line and press Space to bring up the palette. Try using it to expand on existing content, summarize disorganized notes, translate your text, and much more.

• We’ve added a new Home section that highlights important things that might need your attention — such as open change requests, replies to your comments, recent page edits, and other big changes you might want to check out. You can access it from the sidebar.

• You can now use new block types when editing a snippet, including images, files, drawings and API blocks. And we’ve removed the need to save changes you make manually — now, any updates you make will save automatically, just like a normal page.

➕ Improved

• Git Sync can now parse table columns that use the Select column type, and show that data in GitHub or GitLab.

• We’ve made some small improvements to the Add new… menu at the bottom of the table of contents and the resulting modals — including clearer UI copy and some nice new icons.

• You should see a big improvement in the speed and reliability of Git Sync, as we’ve made some backend changes that help things run more smoothly.

🔧 Fixed

• Fixed an issue that stopped a space’s footer inheriting customization settings from its collection.

• Fixed the icon in the tooltip for an inline link, which was displaying too small.

• Fixed a bug that could cause a RangeError when adding math formulae to a space with Git Sync enabled.

• Fixed some bugs that prevented you from dragging and dropping items in a collection in list view or grid view

Small improvements and bug fixes

We’ve shipped some small but useful improvements to the app, and squashed some pesky bugs.

✨ New

• We’ve added a discovery date to the Content audit panel, so you can see when a conflict or duplicate was found.

• Admins can now remove themselves (and other admins) from an organization, as long as they’re not the only remaining admin.

• There’s a new Markdown shortcut to add a divider to your page. Type --- and on an empty line and hit Enter to add a divider.

➕ Improved

• Added a notification to show if there’s an error when duplicating a space.

• You can now update or remove a space’s emoji using the API.

• When you’re viewing your space’s user ratings in the Insights panel, you can now jump to a listed page by clicking it.

• You’ll now see a maximum of three user avatars in the footer, so if multiple people have edited a space recently it won’t fill the width of your content.

🔧 Fixed

• Fixed some graphical issues with diff icons and GitBook AI search answers.

• Fixed an issue where merging a change request just after editing the content could occasionally cause the merged revision to be out of date.

• Fixed an issue that sometimes caused an invisible comments button to published content, and resulted in duplicated URLs.

• Fixed a crash that could sometimes occur when viewing the spaces or teams a user was a part of in an organization.

• Fixed an issue where published content using links in headers could cause visual flashing.

• Fixed an issue where snippets and comments didn’t save.

Turn snippets into docs, change your public docs font and more

We’re making it even easier to turn knowledge into documentation in your knowledge base, adding a free customization option for everyone, and much more.

✨ New

• You can now easily turn snippets into documentation pages in your knowledge base! So when you’ve saved a technical guide from a really helpful thread in your #engineering Slack channel, you can now add it to exactly the right space in GitBook, for everyone to find and use.

• You can now reference snippets in your documentation, using either the new snippets block, or using a # style mention. So even if you don’t want to turn your snippet into it’s own page, you can still point people toward it when you need to.

• We’re making it easier to set up visitor authentication for your published documentation without needing a custom backend. Instead, you can install integrations that serve as the backend for authenticating users and generating JWT tokens. We’re testing this with selected customers right now, and will open it up to all Pro and Enterprise organizations soon.

• We’ve restored Inter as the default font choice for public content, as Inter has better support for more languages than Favorit. You can switch your font back to Favorit in the Customize menu if you prefer — and we’ve made it available to everyone, no matter what plan you’re on.

➕ Improved

• You can now quickly create a snippet using the + button next to Snippets title in the sidebar.

• We improved support for lists in search results when using GitBook AI search.

• We’ve also improved the quality of suggested questions in GitBook AI search so that it uses actual content within the organization.

• We’ve updated the template screen to reflect the new brand colors.

• The Git Sync side panel will now hide while its progress model is showing.

• Comments on deleted pages now appear at the bottom of the list of comments.

• Readers in your organization can now access and read snippets too.

• We’ve updated our primary colors in the app to improve color contrast and accessibility.

• You can now edit a collection’s title and description, or delete a collection using the API.

🔧 Fixed

• Fixed an issue that caused the search modal to change widths as you typed.

• Fixed an SPI error that occurred when you submitted a change request with no reviewers.

• Fixed an issue where changing the title would cause focus to move away from the page.

• Tidied up some text inconsistencies in the app following our recent font change.

• Fixed a bug that caused a slug not to be generated properly when a Git Sync import didn’t include a SUMMARY.md.

• Fixed an issue that caused the content Change Request side panel to overflow into the header when it overflowed.

• Fixed a bug that could cause some admin rights to be overwritten when an admin visited an invite link.

• Fixed direct links to relations in the Content audit section of Insights.

• Fixed an issue that could show an error when modifying header links in published content using the Customize menu.

• Fix an issue where badly parsed math blocks could cause a Git Sync failure or an app crash.

• Fixed a bug that meant the error screen didn’t respond to light or dark mode.

• Fixed a bug that caused the footer not to show in published collections.

A huge update for GitBook

New integrations, a more modern design, better performance, and new features to help you audit and improve your content.

✨ New

There’s a lot to talk about this month! To read more about our epic release, head over to our announcement blog post. Or read on below to get a quick summary, plus more details on smaller changes.

• An improved Slack integration (beta) – Got useful knowledge in a thread? You can now summon our Slack bot in a message thread and it’ll extract the essential information and summarize it in your knowledge base, so you and your team can find and use it later. You can also ask our Slack bot a question and it’ll use GitBook AI to answer it using information in your knowledge base.

• A new VS Code integration (alpha) – With this new integration, you can capture knowledge while you code. Just narrate a process while you work, and GitBook will combine your actions and voiceover into documentation. And just like in Slack, you can also access useful docs right in VS Code, just by asking a question.

• See your knowledge snippets (beta) – All the knowledge you capture using the new Slack and VS Code integrations will appear in the new Snippets page, where you can edit them, copy them to a specific section of your knowledge base, and more. GitBook AI indexes all these snippets automatically, and will use them in answers when you ask a question.

• Improved content insights (closed beta) – Insights now live on their own page, accessible from the sidebar. The new Content audit tab uses AI to show pages that feature contradictory information, or duplicated content. So you can find outdated pages that need your attention, and quickly add updated knowledge. Apply to get access directly from the GitBook app.

• A new design – We’ve overhauled the design of our entire app, added new icons and streamlined the sidebar to make everything cleaner and more modern

➕ Improved

• We’ve added a Show/Hide button for the table of contents, so you can temporarily collapse it and focus on your content if you wish.

• You can now create new collections and spaces, or import your content, using the + button next to the Documentation section title — giving you more space to view content in the sidebar.

• We’ve moved the Trash to the bottom of the sidebar, and opening it now opens a new page so it’s easier to find a deleted space or collection.

• We’ve made the sidebar slightly wider so you can see more of those long space and collection titles.

• You’ll now see a quick animation when you open and close side panels for a smoother feel.

• We’ve changed the Activity side panel to focus on the changes made in your version history.

• You’ll find a new font — Favorit — in the customization options for published spaces.

• We’ve changed the text in the search bar to say Ask or search, to make it more obvious that you can ask GitBook AI a question about your content and get an answer in seconds.

• You can now comment on a whole page using the new Comment on page button above the header.

🔧 Fixed

• Fixed an oversized alert on the notifications icon.

• Fixed some visual issues with side panels and tabbed blocks in dark mode.

• Fixed some minor spacing issues in the new sidebar.

• Fixed an issue that scrolled to the top of a page when you selected a specific comment from the side panel.

• Fixed a bug that sometimes cause the page to reload when you opened the comments side panel.

• Fixed a bug that showed the user avatar in the wrong place when writing a new comment.

Feedback scoring overhaul in the API

We’ve revised how feedback scores are calculated in the Insights API.

Breaking: changing feedback score computation logic

We’ve changed the way we compute the feedback score based on user ratings which is affecting the following endpoint: /v1/spaces/:id/insights/content

• [Updated] score is now calculated this way$score = positives - 0.5 * intermediates - 2*negatives$. This is done to reinforce negative ratings and help surfacing content that may require updates.

• [Updated] rating is now computed this way

  • 'good' whenever the score is > 0

  • 'ok' whenever the score is 0

  • 'bad' whenever the score is < 0

• [Added] ponderedScore is computed by multiplying the score by the total amount of ratings given by visitors.