Skip to content

Add alt text to all docs images #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion account-management/account-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: View and manage the settings for your personal GitBook account.

You can manage your login details, third-party login options, GitBook subdomain, interface theme, notification, integrations and API access tokens.

<figure><img src="../.gitbook/assets/10_01_25_account_settings.svg" alt=""><figcaption><p>Your personal settings page.</p></figcaption></figure>
<figure><img src="../.gitbook/assets/10_01_25_account_settings.svg" alt="A GitBook screenshot showing the personal settings page" ><figcaption><p>Your personal settings page.</p></figcaption></figure>

### How to access your personal account settings

Expand Down
2 changes: 1 addition & 1 deletion account-management/billing-faq/cancelling-a-plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Only administrators can access an organization’s billing settings to cancel a

If your mind is made up, here’s how to cancel your plan:

1. Go to the organization’s settings page. You can click on the settings <img src="../../.gitbook/assets/settings.png" alt="" data-size="line"> icon at the bottom of the sidebar and then click on **\[organization name] settings** to get there.
1. Go to the organization’s settings page. You can click on the settings <img src="../../.gitbook/assets/settings.png" alt="The settings icon in GitBook" data-size="line"> icon at the bottom of the sidebar and then click on **\[organization name] settings** to get there.
2. Click on the **billing** tab. This will take you to a billing page hosted on Stripe, our payment processor.

<div data-full-width="true">
Expand Down
2 changes: 1 addition & 1 deletion account-management/cancelling-a-plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Here’s how to cancel your plan:

1. Go to the organization’s settings page. You can click on the settings&#x20;

<picture><source srcset="../.gitbook/assets/settings_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/settings_icon_light.svg" alt=""></picture>
<picture><source srcset="../.gitbook/assets/settings_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/settings_icon_light.svg" alt="The Settings icon in GitBook"></picture>

&#x20;icon at the bottom of the sidebar and then click on **\[organization name] settings** to get there.
2. Click on the **billing** tab. This will take you to a billing page hosted on Stripe, our payment processor.
Expand Down
2 changes: 1 addition & 1 deletion account-management/organization-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ icon: sitemap

View and manage the settings for your GitBook organization. These include member management, sign-in methods, integrations, billing and plans.

<figure><img src="../.gitbook/assets/10_01_25_organization_settings.svg" alt=""><figcaption><p>Your organization settings page.</p></figcaption></figure>
<figure><img src="../.gitbook/assets/10_01_25_organization_settings.svg" alt="A GitBook screenshot showing the organization settings page" ><figcaption><p>Your organization settings page.</p></figcaption></figure>

### How to access the settings for an organization

Expand Down
2 changes: 1 addition & 1 deletion account-management/plans/community/sponsored-site-plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: >-
This site plan is only available to users on our [community plan](./).
{% endhint %}

<figure><img src="../../../.gitbook/assets/10_01_25_sponsored_site_plan_hero.svg" alt=""><figcaption><p>Learn more about the sponsored site plan in GitBook.</p></figcaption></figure>
<figure><img src="../../../.gitbook/assets/10_01_25_sponsored_site_plan_hero.svg" alt="A GitBook screenshot showing the sponsored site plan hero section" ><figcaption><p>Learn more about the sponsored site plan in GitBook.</p></figcaption></figure>

The sponsored site plan lets you access all of GitBook’s best docs site features at no cost while displaying a small, relevant ad in the corner of your documentation site. Each view generates revenue for you, turning your documentation into a source of income.

Expand Down
2 changes: 1 addition & 1 deletion account-management/sso-and-saml/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ When you create or manage your organisation, you can add a list of email domains

You can enable email domain SSO in the ’SSO’ section of your organization settings; enter a comma-separated list of email domains you’d like to allow SSO access for and you’re good to go.

<figure><img src="../../.gitbook/assets/10_01_25_sso.svg" alt=""><figcaption><p>Set up SSO for your organization.</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/10_01_25_sso.svg" alt="A GitBook screenshot showing how to configure SSO" ><figcaption><p>Set up SSO for your organization.</p></figcaption></figure>

{% hint style="info" %}
Anyone who joins via an SSO email domain will default to guest access, you can change their role at any time in the members section of your organization settings.
Expand Down
4 changes: 2 additions & 2 deletions api-references/openapi/add-an-openapi-specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: >-

If you have an OpenAPI spec, you can add it to your organization by uploading the file directly, linking to a hosted URL, or using the [GitBook CLI](broken-reference).

<figure><img src="../../.gitbook/assets/02_04_25_add_api_spec.svg" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/02_04_25_add_api_spec.svg" alt="A GitBook screenshot showing the modal for generating API docs automatically" ><figcaption></figcaption></figure>

### How to add a specification

Expand All @@ -20,7 +20,7 @@ If you have an OpenAPI spec, you can add it to your organization by uploading th
* Enter a URL to a hosted spec
* Use the CLI to publish the spec

<figure><img src="../../.gitbook/assets/03_04_25_api_spec_modal (1).svg" alt=""><figcaption><p>Add an OpenAPI specification modal.</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/03_04_25_api_spec_modal (1).svg" alt="A GitBook screenshot showing the Add an OpenAPI specification modal"><figcaption><p>Add an OpenAPI specification modal.</p></figcaption></figure>

### Update your specification

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Endpoints added from your spec will continue to be updated anytime your spec is

After you’ve [added your OpenAPI spec](add-an-openapi-specification.md), you can generate endpoint pages by inserting an **OpenAPI Reference** in the table of contents of a Space.

<figure><img src="../../.gitbook/assets/03_04_25_create_api_pages.svg" alt=""><figcaption><p>Insert API References in the table of contents of a Space.</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/03_04_25_create_api_pages.svg" alt="A GitBook screenshot showing how to insert API references into the table of contents of a space" ><figcaption><p>Insert API References in the table of contents of a Space.</p></figcaption></figure>

{% stepper %}
{% step %}
Expand Down
4 changes: 2 additions & 2 deletions collaboration/change-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ A change request is a copy of your main content. It comes from the simple concep

In a change request, you can edit, update and delete elements of your content, request reviews on your changes, then merge them back into your main version to apply all the changes you made.

<figure><img src="../.gitbook/assets/10_01_25_change_requests.svg" alt=""><figcaption><p>Edit your content through change requests.</p></figcaption></figure>
<figure><img src="../.gitbook/assets/10_01_25_change_requests.svg" alt="A GitBook screenshot showing the change requests panel" ><figcaption><p>Edit your content through change requests.</p></figcaption></figure>

### Creating a change request

Expand Down Expand Up @@ -120,4 +120,4 @@ If you don’t want to choose between versions, you can resolve a merge conflict

If you decide not to merge a change request and want to remove it from the queue, you can archive it.

To archive a change request, first open it up. Then click the **Actions menu** <picture><source srcset="../.gitbook/assets/actions-horizontal - dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions-horizontal.svg" alt=""></picture> next to the change request’s title and choose **Archive**. You can find and reopen archived change requests later by opening the **Change Requests** menu and selecting the **Archived** tab.
To archive a change request, first open it up. Then click the **Actions menu** <picture><source srcset="../.gitbook/assets/actions-horizontal - dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions-horizontal.svg" alt="The Actions menu icon in GitBook"></picture> next to the change request’s title and choose **Archive**. You can find and reopen archived change requests later by opening the **Change Requests** menu and selecting the **Archived** tab.
6 changes: 3 additions & 3 deletions collaboration/collaboration/change-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Learn about editing with change requests

<div data-full-width="true">

<figure><img src="../../.gitbook/assets/Change requests collab.png" alt=""><figcaption><p>The change requests panel</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/Change requests collab.png" alt="A GitBook screenshot showing the change requests panel" ><figcaption><p>The change requests panel</p></figcaption></figure>

</div>

Expand All @@ -26,7 +26,7 @@ In a space that is **locked** for live edits, hit the ’Edit’ button in the s

<div data-full-width="true">

<figure><img src="../../.gitbook/assets/start a change request.png" alt=""><figcaption><p>Click the "Edit" button in the top right corner to start a change request</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/start a change request.png" alt="A GitBook screenshot showing how to start a change request" ><figcaption><p>Click the "Edit" button in the top right corner to start a change request</p></figcaption></figure>

</div>

Expand All @@ -42,7 +42,7 @@ Once you’re happy with your changes, you can **submit** the change request.

<div data-full-width="true">

<figure><img src="../../.gitbook/assets/submit for review.png" alt=""><figcaption><p>Submit your change request for review in the bottom right corner of the editor</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/submit for review.png" alt="A GitBook screenshot showing the submit for review button" ><figcaption><p>Submit your change request for review in the bottom right corner of the editor</p></figcaption></figure>

</div>

Expand Down
2 changes: 1 addition & 1 deletion collaboration/collaboration/live-edits.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ You can lock or unlock space for live edits by selecting ’Unlock live edits’

<div data-full-width="true">

<figure><img src="../../.gitbook/assets/Unlock live edits.png" alt=""><figcaption><p>Unlock live edits from the space actions menu</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/Unlock live edits.png" alt="A GitBook screenshot showing the Unlock live edits option" ><figcaption><p>Unlock live edits from the space actions menu</p></figcaption></figure>

</div>

Expand Down
2 changes: 1 addition & 1 deletion collaboration/comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Comments allow you to provide feedback around specific pieces of content — wit

### Add a comment <a href="#comment-within-your-content" id="comment-within-your-content"></a>

You can open the comments panel by clicking on the **Comments** button <picture><source srcset="../.gitbook/assets/comment_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/comment_icon_light.svg" alt=""></picture> in the [space header](../resources/gitbook-ui.md#space-header).
You can open the comments panel by clicking on the **Comments** button <picture><source srcset="../.gitbook/assets/comment_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/comment_icon_light.svg" alt="The Comments button icon in GitBook"></picture> in the [space header](../resources/gitbook-ui.md#space-header).

Adding a comment here will attach a comment to the entire page. You can also comment on a specific block by hovering over a block and clicking the content icon that appears on the right.

Expand Down
2 changes: 1 addition & 1 deletion collaboration/live-edits.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ GitBook supports live collaboration, meaning you’ll be able to work on the sam

### Toggling live edit mode

You can toggle live edit mode in a space by selecting **Lock live edits** or **Unlock live edits** from the [space header’s](../resources/gitbook-ui.md#space-header) **Actions menu** <picture><source srcset="../.gitbook/assets/actions-horizontal - dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions-horizontal.svg" alt=""></picture>.&#x20;
You can toggle live edit mode in a space by selecting **Lock live edits** or **Unlock live edits** from the [space header’s](../resources/gitbook-ui.md#space-header) **Actions menu** <picture><source srcset="../.gitbook/assets/actions-horizontal - dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions-horizontal.svg" alt="The Actions menu icon in GitBook"></picture>.&#x20;

When a space is in **Live edits** mode, the space header will show the **Editor** tab. When it is in **Locked live edits** mode, the space header will show a **Read-only** tab. When the Read-only tab appears in the space header, you will need to open a change request to edit the content of the page.

Expand Down
4 changes: 2 additions & 2 deletions collaboration/pdf-export.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ Note that links across spaces are not currently supported when exporting interna

#### Export an individual page

1. Open the page you want to export, then open the page’s [Actions menu](../resources/gitbook-ui.md#the-actions-menu) <picture><source srcset="../.gitbook/assets/actions_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions_icon_light.svg" alt=""></picture> next to the page title.
1. Open the page you want to export, then open the page’s [Actions menu](../resources/gitbook-ui.md#the-actions-menu) <picture><source srcset="../.gitbook/assets/actions_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions_icon_light.svg" alt="The Actions menu icon in GitBook"></picture> next to the page title.
2. Select **Export to PDF > Current page**.
3. Wait for the page to load, then click the **Print or save as PDF** button in the upper right to open your browsers Print menu.
4. From here, you can save the page as a PDF or open it in your PDF viewer using the typical process for your browser.

#### Export an entire space

1. Open the[ Actions menu](../creating-content/content-structure/) <picture><source srcset="../.gitbook/assets/actions_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions_icon_light.svg" alt=""></picture> next to the page title and choose **Export as PDF > All pages**. Alternatively, open the space’s **Actions menu** <picture><source srcset="../.gitbook/assets/actions-horizontal - dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions-horizontal.svg" alt=""></picture> in the [space header](../resources/gitbook-ui.md#space-header) and choose **Export as PDF** in the drop-down menu.\
1. Open the[ Actions menu](../creating-content/content-structure/) <picture><source srcset="../.gitbook/assets/actions_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions_icon_light.svg" alt="The Actions menu icon in GitBook"></picture> next to the page title and choose **Export as PDF > All pages**. Alternatively, open the space’s **Actions menu** <picture><source srcset="../.gitbook/assets/actions-horizontal - dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions-horizontal.svg" alt="The Actions menu icon in GitBook"></picture> in the [space header](../resources/gitbook-ui.md#space-header) and choose **Export as PDF** in the drop-down menu.\
\
&#xNAN;_&#x4E;ote: This action is not available within a change request._
2. Wait for the page to load, then click the **Print or save as PDF** button in the upper right to open your browsers Print menu.
Expand Down
4 changes: 2 additions & 2 deletions collaboration/share.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Collaborate with your teammates on spaces, collections and more

# Inviting your team

<figure><img src="../.gitbook/assets/10_01_25_invite_team.svg" alt=""><figcaption><p>Invite your team to GitBook to collaborate on pages, spaces, and published sites.</p></figcaption></figure>
<figure><img src="../.gitbook/assets/10_01_25_invite_team.svg" alt="A GitBook screenshot showing the invite team dialog" ><figcaption><p>Invite your team to GitBook to collaborate on pages, spaces, and published sites.</p></figcaption></figure>

### Sharing a space or collection

Expand Down Expand Up @@ -45,4 +45,4 @@ If you don’t want to use email to invite someone to your content, or want to i

When you share this link, anyone who clicks on it will be able to sign up, join your organization as a [guest](../account-management/member-management/roles.md#guest-role), and get access to just this single space and its content.&#x20;

You can revoke the link at any time by opening the **Actions menu** <picture><source srcset="../.gitbook/assets/actions_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions_icon_light.svg" alt=""></picture> next to the link and choosing **Revoke**.
You can revoke the link at any time by opening the **Actions menu** <picture><source srcset="../.gitbook/assets/actions_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../.gitbook/assets/actions_icon_light.svg" alt="The Actions menu icon in GitBook"></picture> next to the link and choosing **Revoke**.
4 changes: 2 additions & 2 deletions creating-content/blocks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ icon: square-dashed-circle-plus

GitBook is a block-based editor, meaning you can add different kinds of blocks to your content — from standard text and images to interactive blocks. Your pages can include any combination of blocks you want, and there’s no limit to the number of blocks you can have on a page.

<figure><img src="../../.gitbook/assets/10_01_25_content_blocks.svg" alt=""><figcaption><p>GitBook's built in content blocks.</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/10_01_25_content_blocks.svg" alt="A GitBook screenshot showing the available content blocks" ><figcaption><p>GitBook's built in content blocks.</p></figcaption></figure>

### Inserting a new content block

Expand Down Expand Up @@ -41,7 +41,7 @@ Once selected, you can:

By making your blocks full width, you can create a clear visual hierarchy in your content, or simply give more space to content that needs it.

To make a block full width, click on the **Options menu** <picture><source srcset="../../.gitbook/assets/options_menu_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../../.gitbook/assets/options_menu_icon_light.svg" alt=""></picture> next to your block and select **Full width**. This feature is available for the following block types:
To make a block full width, click on the **Options menu** <picture><source srcset="../../.gitbook/assets/options_menu_icon_dark.svg" media="(prefers-color-scheme: dark)"><img src="../../.gitbook/assets/options_menu_icon_light.svg" alt="The Options menu icon in GitBook"></picture> next to your block and select **Full width**. This feature is available for the following block types:

* Code Blocks
* Image blocks
Expand Down
Loading