Accessibility

D

Landmark Structure

Action

No landmarks

FIX

No landmarks

No <main> landmark found

Screen reader users cannot quickly navigate to the primary content. Wrap your main content in <main>.

No <nav> landmark found

No banner (header) landmark

No contentinfo (footer) landmark

Skip navigation link is missing (WCAG 2.4.1)

Add a skip link as the first focusable element so keyboard users can bypass repeated navigation.

No landmarks detected

Screen reader users have no way to navigate by region.

Screen reader users cannot quickly navigate to the primary content. Wrap your main content in <main>.

Why this matters

Without a <main> landmark, screen-reader users can't skip past the navigation to the page content — every page starts with re-reading the menu.

Learn more ▾

The <main> element marks the page's primary content area. Assistive tech offers a 'jump to main' shortcut — but only if <main> exists. Without it, every page navigation forces re-reading the header. Wrap your primary content in a single <main>.

Source: WAI-ARIA / WCAG 2.4.1

Add a skip link as the first focusable element so keyboard users can bypass repeated navigation.

Why this matters

Without a skip-nav link, keyboard users tab through every nav item before reaching content — every page, every visit.

Learn more ▾

WCAG 2.4.1 (Bypass Blocks) requires a mechanism to skip past repeated content. The standard implementation is a 'Skip to main content' link that's the first focusable element, visually hidden until focused. Three lines of HTML + four of CSS.

Source: WCAG 2.1 SC 2.4.1

F

Heading Hierarchy

Action

21 headings, 4 skip(s)

FIX

21 headings, 4 skip(s)

Multiple H1 headings (2 found)

A page should have only one H1. Multiple H1s dilute the document outline.

Heading level skipped: H2 → H5 (missing H3)

Skipping heading levels breaks the document outline. Screen readers may interpret missing levels as structural errors.

Heading level skipped: H2 → H5 (missing H3)

Skipping heading levels breaks the document outline. Screen readers may interpret missing levels as structural errors.

Heading level skipped: H2 → H4 (missing H3)

Skipping heading levels breaks the document outline. Screen readers may interpret missing levels as structural errors.

Heading level skipped: H2 → H5 (missing H3)

Skipping heading levels breaks the document outline. Screen readers may interpret missing levels as structural errors.

H1 Turn documentation into your product’s knowledge system
H2 Docs that are an extension of your product
H5 Your product and docs, in sync (finally) skipped
H5 Built for humans, optimized for AI
H4 “GitBook helps every department — it’s just easy cross-collaboration. One tool does it all, and we don’t have to hold somebody’s hand through the docs process. It’s made life very easy.”
H3 A connected, personalized AI Assistant
H2 Docs tools for teams who care about quality
H5 A workflow your entire team will love skipped
H5 A best-in-class editing experience
H5 Team up with a proactive partner
H2 Built to perform
H4 “We wanted to really customize the look and feel of our documentation and to link it to our visual identity as a brand. And with GitBook, we managed to do everything we wanted.” skipped
H3 A connected layer for product knowledge
H2 Enterprise-grade docs intelligence
H5 Migration and support skipped
H5 Access control
H5 Security and compliance
H5 Auth-protected content
H4 We view GitBook as a growth tool. If our docs are easy to use, our users will be successful and adopt our products. By making it simple for developers to get their first ‘aha!’ moment, GitBook hel
H2 Companies like yours are building better docs with GitBook
H1 Build knowledge that never stands still duplicate H1

A page should have only one H1. Multiple H1s dilute the document outline.

Why this matters

Multiple H1s blur the page's primary topic — screen-reader users and Google both prefer one H1.

Learn more ▾

HTML5's outline algorithm technically allows multiple H1s within sectioning content, but no browser implements it. In practice: one H1 per page. Use H2-H6 for subsections.

Source: WCAG 2.4.6 / Google Search Central

Skipping heading levels breaks the document outline. Screen readers may interpret missing levels as structural errors.

Why this matters

Skipping heading levels breaks the document outline — screen-reader users lose track of section nesting.

Learn more ▾

Screen reader users navigate by jumping between headings (H1 → H2 → H3). Skipping (H1 → H3) breaks the sense of hierarchy. Use sequential levels even if you don't like the default styling — restyle with CSS instead. WCAG 1.3.1 (Info and Relationships) treats this as an A failure.

Source: WCAG 2.1 SC 1.3.1 / W3C WAI

Skipping heading levels breaks the document outline. Screen readers may interpret missing levels as structural errors.

Why this matters

Skipping heading levels breaks the document outline — screen-reader users lose track of section nesting.

Learn more ▾

Screen reader users navigate by jumping between headings (H1 → H2 → H3). Skipping (H1 → H3) breaks the sense of hierarchy. Use sequential levels even if you don't like the default styling — restyle with CSS instead. WCAG 1.3.1 (Info and Relationships) treats this as an A failure.

Source: WCAG 2.1 SC 1.3.1 / W3C WAI

Skipping heading levels breaks the document outline. Screen readers may interpret missing levels as structural errors.

Why this matters

Skipping heading levels breaks the document outline — screen-reader users lose track of section nesting.

Learn more ▾

Screen reader users navigate by jumping between headings (H1 → H2 → H3). Skipping (H1 → H3) breaks the sense of hierarchy. Use sequential levels even if you don't like the default styling — restyle with CSS instead. WCAG 1.3.1 (Info and Relationships) treats this as an A failure.

Source: WCAG 2.1 SC 1.3.1 / W3C WAI

Skipping heading levels breaks the document outline. Screen readers may interpret missing levels as structural errors.

Why this matters

Skipping heading levels breaks the document outline — screen-reader users lose track of section nesting.

Learn more ▾

Screen reader users navigate by jumping between headings (H1 → H2 → H3). Skipping (H1 → H3) breaks the sense of hierarchy. Use sequential levels even if you don't like the default styling — restyle with CSS instead. WCAG 1.3.1 (Info and Relationships) treats this as an A failure.

Source: WCAG 2.1 SC 1.3.1 / W3C WAI

D

Link & Button Quality

Action

12 issue(s) across 70 links and 1 buttons

FIX

12 issue(s) across 70 links and 1 buttons

11 link(s) with no accessible text

Links without text are announced as raw URLs by screen readers.

Got: ./; ./customers/bunq; ./customers/sonar; ./customers/nexthink; ./customers/fedex; ./customers/xplorpay; ./; https://github.com/GitbookIO; https://x.com/GitBookIO; https://www.linkedin.com/company/gitbook/ (+1 more)

1 link(s) with generic text

Generic link text like 'click here' doesn't describe the destination.

Got: ./enterprise ("Learn more")

11 link(s) open in new tab without warning

Add '(opens in new tab)' to link text or aria-label.

Got: https://gitbook.com/docs; https://gitbook.com/docs/developers; https://gitbook.com/docs/guides; https://gitbook.com/docs/policies/terms; https://gitbook.com/docs/policies/privacy-and-security/statement; https://www.youtube.com/@gitbookIO; https://gitbook.com/docs/help-center; https://gitbook.com/docs/changelog; https://www.gitbookstatus.com/; https://security.gitbook.com/ (+1 more)

47 link(s) with descriptive text

70 links

11 empty

1 generic text

11 new tab

0 empty buttons

Element	Text	Issue	Suggested Fix
./	(empty)	empty	Add link text or aria-label
./enterprise	Learn more	generic text	Replace with descriptive text
Before: Learn more Suggested: Enterprise
./customers/bunq	(empty)	empty	Add link text or aria-label
./customers/sonar	(empty)	empty	Add link text or aria-label
./customers/nexthink	(empty)	empty	Add link text or aria-label
./customers/fedex	(empty)	empty	Add link text or aria-label
./customers/xplorpay	(empty)	empty	Add link text or aria-label
./	(empty)	empty	Add link text or aria-label
https://github.com/GitbookIO	(empty)	empty	Add link text or aria-label
https://x.com/GitBookIO	(empty)	empty	Add link text or aria-label
https://www.linkedin.com/company/gitbook…	(empty)	empty	Add link text or aria-label
https://www.youtube.com/@gitbookIO	(empty)	empty	Add link text or aria-label
https://gitbook.com/docs	GitBook product docs	new tab	Add '(opens in new tab)' to text
https://gitbook.com/docs/developers	GitBook developer docs	new tab	Add '(opens in new tab)' to text
https://gitbook.com/docs/guides	GitBook guides	new tab	Add '(opens in new tab)' to text
https://gitbook.com/docs/policies/terms	Terms of service	new tab	Add '(opens in new tab)' to text
https://gitbook.com/docs/policies/privac…	Privacy statement	new tab	Add '(opens in new tab)' to text
https://www.youtube.com/@gitbookIO	Videos	new tab	Add '(opens in new tab)' to text
https://gitbook.com/docs/help-center	Help center	new tab	Add '(opens in new tab)' to text
https://gitbook.com/docs/changelog	Changelog	new tab	Add '(opens in new tab)' to text
https://www.gitbookstatus.com/	Status	new tab	Add '(opens in new tab)' to text
https://security.gitbook.com/	Security and compliance	new tab	Add '(opens in new tab)' to text
https://www.gitbook.com/blog/gitbook-sec…	The SOC 2 logo	new tab	Add '(opens in new tab)' to text

48 links and buttons have descriptive text

Links without text are announced as raw URLs by screen readers.

./; ./customers/bunq; ./customers/sonar; ./customers/nexthink; ./customers/fedex; ./customers/xplorpay; ./; https://github.com/GitbookIO; https://x.com/GitBookIO; https://www.linkedin.com/company/gitbook/ (+1 more)

Why this matters

Links with no accessible text (empty <a></a>, image-only no alt, icon-only no aria-label) are unidentifiable to screen readers.

Source: WCAG 2.1 SC 2.4.4

Generic link text like 'click here' doesn't describe the destination.

./enterprise ("Learn more")

Why this matters

Generic anchor text ('click here', 'read more', 'learn more') tells screen readers and search engines nothing about the destination.

Learn more ▾

Out-of-context lists of links read by AT (one navigation pattern) become useless when every link says 'click here'. Use the destination's title or topic as anchor text. Doubles as SEO win — Google passes anchor-text relevance to the destination.

Source: WCAG 2.4.4 / Google Search Central

Add '(opens in new tab)' to link text or aria-label.

https://gitbook.com/docs; https://gitbook.com/docs/developers; https://gitbook.com/docs/guides; https://gitbook.com/docs/policies/terms; https://gitbook.com/docs/policies/privacy-and-security/statement; https://www.youtube.com/@gitbookIO; https://gitbook.com/docs/help-center; https://gitbook.com/docs/changelog; https://www.gitbookstatus.com/; https://security.gitbook.com/ (+1 more)

Why this matters

Links with target="_blank" without rel="noopener" leak the originating page's window context — security and UX issue.

Learn more ▾

Without rel="noopener", the new tab can navigate the original tab via window.opener (tab-nabbing attack). Modern browsers default to noopener for target=_blank but only since recent versions. Always set rel="noopener noreferrer" explicitly.

Source: MDN target / OWASP

D

Favicon & Branding

Action

3 icon(s) detected

FIX

3 icon(s) detected

No favicon.ico at site root

Some older browsers, bookmark tools, and RSS readers look for /favicon.ico. Add one as a fallback.

HTML icon links detected

Apple touch icon present

✗ favicon.ico Missing

✓ PNG Icons Present

✓ Apple Touch Present

✗ SVG Favicon Missing

✗ Manifest Icons Missing

✗ Multiple Sizes Missing

D

Web Manifest

Action

Not found

FIX

Not found

No web manifest found

No manifest at standard paths (/manifest.json, /site.webmanifest). A manifest is optional but enables PWA features like home screen installation and standalone display.

No web manifest found.

D

Print Stylesheet

Action

No print styles

FIX

No print styles

No print-specific styles detected

When users print this page, they get the screen layout including navigation and non-essential elements. Add @media print rules to hide navigation and optimize layout for paper.

Print Stylesheet No Print Styles

Print stylesheet Not found ✗Inline @media print Not detected ✗

F

Navigation UX

Action

No navigation patterns

FIX

No navigation patterns

No breadcrumbs, search, or skip link detected

These navigation aids help users orient themselves and find content efficiently, especially on large sites.

Breadcrumbs

Search

Skip Link

Labeled Navigation

Back to Top

Hamburger Menu

Sticky Navigation Cannot reliably detect (CSS-based)

0 of 6 testable patterns navigation patterns detected. Limited navigation support. Consider adding breadcrumbs, search, and skip link.

C

404 Error Page

Action

HTTP 404, custom page

REVIEW

HTTP 404, custom page

Correct 404 status code returned

Got: HTTP 404

Custom styled 404 page

404 Page Quality ✓ Custom 404 Page

Status Code HTTP 404 ✓Page Title 404 page not found | GitBook ✓Custom Styling ✓Navigation ✗Homepage Link ✗Search Form ✗

B

Dark Mode Support

Dark mode detected

REVIEW

Dark mode detected

prefers-color-scheme CSS detected in inline styles

Detection limited to meta tags and inline styles

External CSS files may contain prefers-color-scheme rules not visible to this scan.

Dark Mode✓ Dark Mode Supported

color-scheme meta Not set ✗Dark theme-color Not set ✗CSS indicators Detected ✓

Detection limited to meta tags and inline styles.

B

Lighthouse Accessibility Audits

Score 83/100 — 4 failing, 13 passed

REVIEW

83

These checks highlight opportunities to improve the accessibility of your web app. Automatic detection can only detect a subset of issues and does not guarantee the accessibility of your web app, so manual testing is also encouraged.

Contrast

Low-contrast text is difficult or impossible for many users to read. Learn how to provide sufficient color contrast.

Why this matters

Performance issues directly impact user engagement and conversion rates.

Failing Elements
New `a.framer-1ykzfug > div.framer-1esd1ut > div.framer-12bvbki > p.framer-text`
GITBOOK AGENT `div.framer-z2q369 > div.framer-16phfas > div.framer-18q1fbg > p.framer-text`
Beta `a.framer-TA3qw > div.framer-1lig7ba > div.framer-bd5p7u > p.framer-text`
LLMS.TXT & MCP `div.framer-z2q369 > div.framer-16phfas > div.framer-18q1fbg > p.framer-text`
EMBEDDED ASSISTANT `div.framer-usj5hv > div.framer-wkbwqq > div.framer-19wl25j > p.framer-text`
GIT SYNC `div.framer-z2q369 > div.framer-16phfas > div.framer-18q1fbg > p.framer-text`
VISUAL EDITOR `div.framer-z2q369 > div.framer-16phfas > div.framer-18q1fbg > p.framer-text`
GITBOOK AGENT `div.framer-z2q369 > div.framer-16phfas > div.framer-18q1fbg > p.framer-text`
Early access `a.framer-TA3qw > div.framer-1lig7ba > div.framer-bd5p7u > p.framer-text`
CONNECTED KNOWLEDGE `div.framer-usj5hv > div.framer-wkbwqq > div.framer-19wl25j > p.framer-text`
CUSTOMER STORIES `div.framer-1scchmi > div.framer-1le9pes > div.framer-g1mn02 > p.framer-text`

These are opportunities to improve the legibility of your content.

Navigation

Properly ordered headings that do not skip levels convey the semantic structure of the page, making it easier to navigate and understand when using assistive technologies. Learn more about heading order.

Why this matters

Performance issues directly impact user engagement and conversion rates.

Failing Elements
Your product and docs, in sync (finally) `div.framer-z2q369 > div.framer-16phfas > div.framer-465303 > h5.framer-text`
A workflow your entire team will love `div.framer-z2q369 > div.framer-16phfas > div.framer-465303 > h5.framer-text`
“We wanted to really customize the look and feel of our documentation and to li… `div.framer-cq1e3g > div.framer-1dzqw3u > div.framer-lsmlz6 > h4.framer-text`
Migration and support `div.framer-1q5b0e0 > div.framer-1u8ou9j > div.framer-1x3jgkz > h5.framer-text`

These are opportunities to improve keyboard navigation in your application.

Names and labels

Link text (and alternate text for images, when used as links) that is discernible, unique, and focusable improves the navigation experience for screen reader users. Learn how to make links accessible.

Why this matters

Performance issues directly impact user engagement and conversion rates.

Failing Elements
div.framer-1sm3ux8-container > div.framer-dHWFU > div.framer-1bu092d > a.framer-84rpwu `div.framer-1sm3ux8-container > div.framer-dHWFU > div.framer-1bu092d > a.framer-84rpwu`
div.framer-iyxsyh-container > div.framer-0jzu6 > div.framer-1yixnu4 > a.framer-1oziz0a `div.framer-iyxsyh-container > div.framer-0jzu6 > div.framer-1yixnu4 > a.framer-1oziz0a`
div.framer-iyxsyh-container > div.framer-0jzu6 > div.framer-1yixnu4 > a.framer-1oziz0a `div.framer-iyxsyh-container > div.framer-0jzu6 > div.framer-1yixnu4 > a.framer-1oziz0a`
div.framer-1r0ae6h-container > div.framer-lS9yM > div.framer-1mvfqkk > a.framer-lhfx46 `div.framer-1r0ae6h-container > div.framer-lS9yM > div.framer-1mvfqkk > a.framer-lhfx46`
div.framer-lS9yM > div.framer-1mvfqkk > div.framer-rk2vz8 > a.framer-l8o5zh `div.framer-lS9yM > div.framer-1mvfqkk > div.framer-rk2vz8 > a.framer-l8o5zh`
div.framer-lS9yM > div.framer-1mvfqkk > div.framer-rk2vz8 > a.framer-1q4uyqu `div.framer-lS9yM > div.framer-1mvfqkk > div.framer-rk2vz8 > a.framer-1q4uyqu`
div.framer-lS9yM > div.framer-1mvfqkk > div.framer-rk2vz8 > a.framer-1ppk0i7 `div.framer-lS9yM > div.framer-1mvfqkk > div.framer-rk2vz8 > a.framer-1ppk0i7`
div.framer-lS9yM > div.framer-1mvfqkk > div.framer-rk2vz8 > a.framer-169b5ft `div.framer-lS9yM > div.framer-1mvfqkk > div.framer-rk2vz8 > a.framer-169b5ft`

These are opportunities to improve the semantics of the controls in your application. This may enhance the experience for users of assistive technology, like a screen reader.

Best practices

One main landmark helps screen reader users navigate a web page. Learn more about landmarks.

Why this matters

Performance issues directly impact user engagement and conversion rates.

Failing Elements
html `html`

These items highlight common accessibility best practices.

○Interactive controls are keyboard focusable

○Interactive elements indicate their purpose and state

○The page has a logical tab order

○Visual order on the page follows DOM order

○User focus is not accidentally trapped in a region

○The user's focus is directed to new content added to the page

○HTML5 landmark elements are used to improve navigation

○Offscreen content is hidden from assistive technology

○Custom controls have associated labels

○Custom controls have ARIA roles

●`[aria-hidden="true"]` is not present on the document `<body>`

●Buttons have an accessible name

●Image elements have `[alt]` attributes

●Input buttons have discernible text.

●`[user-scalable="no"]` is not used in the `<meta name="viewport">` element and the `[maximum-scale]` attribute is not less than 5.

●`[aria-hidden="true"]` elements do not contain focusable descendents

●Document has a `<title>` element

●`<html>` element has a `[lang]` attribute

●`<html>` element has a valid value for its `[lang]` attribute

●Lists contain only `<li>` elements and script supporting elements (`<script>` and `<template>`).

●No element has a `[tabindex]` value greater than 0

●Touch targets have sufficient size and spacing.

●Identical links have the same purpose.

○`[accesskey]` values are unique

○`[aria-*]` attributes match their roles

○`button`, `link`, and `menuitem` elements have accessible names

○ARIA attributes are used as specified for the element's role

○Deprecated ARIA roles were not used

○Elements with `role="dialog"` or `role="alertdialog"` have accessible names.

○ARIA input fields have accessible names

○ARIA `meter` elements have accessible names

○ARIA `progressbar` elements have accessible names

○Elements use only permitted ARIA attributes

○`[role]`s have all required `[aria-*]` attributes

○Elements with an ARIA `[role]` that require children to contain a specific `[role]` have all required children.

○`[role]`s are contained by their required parent element

○`[role]` values are valid

○Elements with the `role=text` attribute do not have focusable descendents.

○ARIA toggle fields have accessible names

○ARIA `tooltip` elements have accessible names

○ARIA `treeitem` elements have accessible names

○`[aria-*]` attributes have valid values

○`[aria-*]` attributes are valid and not misspelled

○The page contains a heading, skip link, or landmark region

○`<dl>`'s contain only properly-ordered `<dt>` and `<dd>` groups, `<script>`, `<template>` or `<div>` elements.

○Definition list items are wrapped in `<dl>` elements

○ARIA IDs are unique

○No form fields have multiple labels

○`<frame>` or `<iframe>` elements have a title

○`<html>` element has an `[xml:lang]` attribute with the same base language as the `[lang]` attribute.

○`<input type="image">` elements have `[alt]` text

○Form elements have associated labels

○Links are distinguishable without relying on color.

○List items (`<li>`) are contained within `<ul>`, `<ol>` or `<menu>` parent elements

○The document does not use `<meta http-equiv="refresh">`

○`<object>` elements have alternate text

○Select elements have associated label elements.

○Skip links are focusable.

○Cells in a `<table>` element that use the `[headers]` attribute refer to table cells within the same table.

○`<th>` elements and elements with `[role="columnheader"/"rowheader"]` have data cells they describe.

○`[lang]` attributes have a valid value

○`<video>` elements contain a `<track>` element with `[kind="captions"]`

○Tables have different content in the summary attribute and `<caption>`.

○All heading elements contain content.

○Uses ARIA roles only on compatible elements

○Image elements do not have `[alt]` attributes that are redundant text.

○Elements with visible text labels have matching accessible names.

○Tables use `<caption>` instead of cells with the `[colspan]` attribute to indicate a caption.

○`<td>` elements in a large `<table>` have one or more table headers.

A+

Alt Text Quality

All 33 images OK

PASS

All 33 images OK

18 decorative image(s) correctly marked

15 image(s) with good alt text

33 images 15 good alt text 18 decorative

All images have appropriate alt text.

A+

Form Accessibility

No form controls

PASS

No form controls

No form controls on this page

No form controls found.

A+

Color Contrast (Screenshot)

20 text elements analyzed, 0 fail WCAG AA

PASS

Analyzes text contrast against the actual rendered page, including background images, gradients, and overlays that CSS-based tools cannot detect.

20 pass

Show all checked elements (20)

Element	Ratio	Required	FG	BG	Result
h1 Build knowledge that…	21.00:1	3.0:1	#000000	#FFFFFF	Pass
h2 Docs that are an ext…	21.00:1	3.0:1	#000000	#FFFFFF	Pass
h2 Docs tools for teams…	21.00:1	3.0:1	#000000	#FFFFFF	Pass
h2 Built to perform	21.00:1	3.0:1	#000000	#FFFFFF	Pass
h2 Enterprise-grade doc…	21.00:1	3.0:1	#000000	#FFFFFF	Pass
h2 Companies like yours…	21.00:1	3.0:1	#000000	#FFFFFF	Pass
h3 A connected, persona…	21.00:1	3.0:1	#000000	#FFFFFF	Pass
h3 A connected layer fo…	21.00:1	3.0:1	#000000	#FFFFFF	Pass
title Turn documentation i…	20.11:1	4.5:1	#000000	#FAFAF9	Pass
p The State of Docs 20…	20.11:1	4.5:1	#000000	#FAFAF9	Pass
p Read the report	21.00:1	4.5:1	#000000	#FFFFFF	Pass
p Login	21.00:1	4.5:1	#000000	#FFFFFF	Pass
p Start for free	21.00:1	4.5:1	#000000	#FFFFFF	Pass
p New	21.00:1	4.5:1	#000000	#FFFFFF	Pass
p Assistant insights, …	21.00:1	4.5:1	#000000	#FFFFFF	Pass
span ’	21.00:1	4.5:1	#000000	#FFFFFF	Pass
p GitBook connects you…	21.00:1	4.5:1	#000000	#FFFFFF	Pass
p Start for free	21.00:1	4.5:1	#000000	#FFFFFF	Pass
p Talk to us	21.00:1	4.5:1	#000000	#FFFFFF	Pass
p Meet our customers	21.00:1	4.5:1	#000000	#FFFFFF	Pass

Methodology: The top 20 text elements by font size were checked. Background color was sampled from the desktop screenshot using a 5-point pattern. WCAG 2.1 AA requires 4.5:1 for normal text and 3:1 for large text.