1 of 45

Test GitBook Open

Welcome

DO NOT REMOVE THIS SPACE OR UNPUBLISH IT

Long text thisisaveryyyylonnnnngwordthatisnotrealisic butit'sok

This page contains text with crazy long term to ensure layout stays good

The content of the document can also contains long text thisisaveryyyylonnnnngwordthatisnotrealisicbutit'sokbutitneedstoworkeveninparagraphandwithawordlongerthantheblockwidth.

Also testing in code block:

// Some code
thisisaveryyyylonnnnngwordthatisnotrealisicbutit'sokbutitneedstoworkeveninparagraphandwithawordlongerthantheblockwidth.

Empty page

Page options

Page no index

This page is not indexed in search (content or google).

Descendant of page no index

This page is also not indexed.

Page no robots index

This page is not indexed in google search.

Descendant of page no robots index

This page is also not indexed in google.

Page with description

This page has a text description

And then some short content

Page with cover

This page has a cover.

Page with dark cover

This page has a cover.

Page with cover and no TOC

This page has a cover.

Page with hero cover

This page has a cover.

Page with icon

Cake

Ice cream

Burger

Blocks

Annotations

This paragraph contains an . It can be opened by clicking it.

In codeblocks

// Some code
and an .

Integrations

A mermaid block:

A GitHub file:

A linear issue

A mailchimp block

Headings

Heading 1

Heading 2

Heading 3

Title 1

Title 2

Title 3

Expandables

Empty

This is an empty expandable (body)

With content

Lorem ipsum

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec in mauris nisi. Fusce suscipit hendrerit ex nec laoreet. Mauris dolor diam, posuere non accumsan at, auctor a lectus. Maecenas porttitor purus ipsum, bibendum volutpat metus tristique in. Fusce et quam sed purus pulvinar dignissim id ut nisi. Fusce malesuada nec leo quis laoreet. Sed elit ligula, porta sed lobortis at, porttitor porttitor sem.

Donec id pulvinar ex, ac consequat odio. Nulla eu ante bibendum, aliquet sapien nec, facilisis metus. Duis non convallis neque, accumsan iaculis risus. Nulla sed ultrices ex, et interdum tellus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Suspendisse porta felis imperdiet ante congue vestibulum. Sed eu mattis turpis. Praesent pharetra turpis eu ligula finibus, non interdum dui posuere. Vivamus facilisis, diam ac luctus lacinia, turpis odio pharetra ex, vitae suscipit orci turpis tincidunt massa.

Marks

The following text is bold and italic. Styles can also be ~~combined~~.

Keyboard maks X + ~~Y~~ + Ctrl + ⌘

Other styles includes code text and colored text.

And super^script and sub_script.

Colors

Text colors:

Purple
Blue
Red
Orange
Yellow
Green

Background colors:

Purple
Blue
Red
Orange
Yellow
Green

Combined:

Purple
Blue
Red
Orange
Yellow
Green

Emojis

Icons

Page links

Link to another page

Link to a file

Link to another space

Link to a private space

API blocks

A first block:

Webhooks :

Models:

Math

A math block that should render with KaTeX:

A math block that should be rendered with MathJax:

Another one with MathJax:

And a bigger one with KaTeX:

Files

File blocks reference a file and are used to help users download specific files.

File blocks can also have a caption:

Embeds

Embed as a card, handled by an integration:

Embed as a card, not handled by an integration

Embed of a youtube video

Embed with a caption

Embed full-width

Lists

Unordered list

First item
Second item
- First nested item
  - Second nested item
Third item

Ordered list

First item
Second item
1. First nested item
  1. Second nested item
Third item

Tasks

Task 1
Task 2, done

Mix

Ordered list item
- Unordered list item

UL With blocks

List item starting with a heading
A paragraph below it.
Text before code block
```
code block
a second line
```
```
Directly, a code block
```

OL With blocks

List item starting with a heading
A paragraph below it.
Text before code block
```
code block
a second line
```
```
Directly, a code block
```

Tasks With blocks

List item starting with a heading
A paragraph below it.
Text before code block
```
code block
a second line
```
```
Directly, a code block
```

Stepper

First step

Content of the step

With another line, and an image

Second step

This is the second step

This is the first step

And it's good!

Columns

Expressions

Integrations

A mermaid block:

A GitHub file:

https://github.com/GitbookIO/gitbook-open/blob/main/package.json#L2-L3

{
    "name": "gitbook",
    "version": "0.1.0",
    "private": true,
    "scripts": {
        "dev": "next dev",
        "build": "next build",
        "build:cloudflare": "next-on-pages",
        "start": "next start",
        "lint": "next lint",
        "format": "prettier ./ --ignore-unknown --write",
        "format:check": "prettier ./ --ignore-unknown --list-different",
        "typecheck": "tsc --noEmit",
        "unit": "bun test {src,packages}/**/*.test.ts",
        "e2e": "playwright test",
        "postinstall": "rm -rf ./public/~gitbook/static/mathjax@3.2.2 && mkdir -p ./public/~gitbook/static/ && cp -R node_modules/mathjax/es5 ./public/~gitbook/static/mathjax@3.2.2"
    },
    "workspaces": [
        "packages/*"
    ],
    "dependencies": {
        "@geist-ui/icons": "^1.0.2",
        "@gitbook/api": "^0.36.0",
        "@radix-ui/react-checkbox": "^1.0.4",
        "@radix-ui/react-popover": "^1.0.7",
        "@sentry/nextjs": "^7.94.1",
        "@tailwindcss/container-queries": "^0.1.1",
        "@tailwindcss/typography": "^0.5.10",
        "@upstash/redis": "^1.27.1",
        "ajv": "^8.12.0",
        "assert-never": "^1.2.1",
        "bun-types": "^1.0.7",
        "content-security-policy-merger": "^1.0.0",
        "framer-motion": "^10.16.14",
        "js-cookie": "^3.0.5",
        "js-yaml": "^4.1.0",
        "jsontoxml": "^1.0.1",
        "katex": "^0.16.9",
        "memoizee": "^0.4.15",
        "next": "^14.1.3",
        "next-themes": "^0.2.1",
        "nuqs": "^1.15.4",
        "object-hash": "^3.0.0",
        "openapi-types": "^12.1.3",
        "p-map": "^7.0.0",
        "parse-cache-control": "^1.0.1",
        "react": "^18",
        "react-dom": "^18",
        "react-hotkeys-hook": "^4.4.1",
        "react-medium-image-zoom": "^5.1.10",
        "recoil": "^0.7.7",
        "rehype-sanitize": "^6.0.0",
        "rehype-stringify": "^10.0.0",
        "remark-parse": "^11.0.0",
        "remark-rehype": "^11.1.0",
        "rison": "^0.1.1",
        "server-only": "^0.0.1",
        "shiki": "^1.2.0",
        "swagger2openapi": "^7.0.8",
        "tailwind-merge": "^2.2.0",
        "tailwind-shades": "^1.1.2",
        "unified": "^11.0.4",
        "url-join": "^5.0.0",
        "mathjax": "^3.2.2",
        "classnames": "^2.5.1"
    },
    "devDependencies": {
        "@argos-ci/playwright": "^2.0.0",
        "@cloudflare/next-on-pages": "^1.9.0",
        "@cloudflare/workers-types": "^4.20231218.0",
        "@playwright/test": "^1.42.1",
        "@types/js-cookie": "^3.0.6",
        "@types/js-yaml": "^4.0.9",
        "@types/jsontoxml": "^1.0.5",
        "@types/jsonwebtoken": "^9.0.6",
        "@types/katex": "^0.16.5",
        "@types/node": "^20",
        "@types/object-hash": "^3.0.6",
        "@types/parse-cache-control": "^1.0.4",
        "@types/psi": "^4.1.6",
        "@types/react": "^18",
        "@types/react-dom": "^18",
        "@types/rison": "^0.0.9",
        "@types/swagger2openapi": "^7.0.4",
        "autoprefixer": "^10",
        "eslint": "^8",
        "eslint-config-next": "13.5.6",
        "eslint-plugin-import": "^2.29.0",
        "jsonwebtoken": "^9.0.2",
        "postcss": "^8",
        "prettier": "^3.0.3",
        "psi": "^4.1.0",
        "tailwindcss": "^3.4.0",
        "typescript": "^5"
    }
}

A linear issue

Render integration blocks

RND-1853•

Done

A mailchimp block

Lists

Unordered list

First item
Second item
- First nested item
  - Second nested item
Third item

Ordered list

First item
Second item
1. First nested item
  1. Second nested item
Third item

Tasks

Task 1
Task 2, done

Mix

Ordered list item
- Unordered list item

UL With blocks

List item starting with a heading
A paragraph below it.
Text before code block
```
code block
a second line
```
```
Directly, a code block
```

OL With blocks

List item starting with a heading
A paragraph below it.
Text before code block
```
code block
a second line
```
```
Directly, a code block
```

Tasks With blocks

List item starting with a heading
A paragraph below it.
Text before code block
```
code block
a second line
```
```
Directly, a code block
```

https://github.com/GitbookIO/gitbook-open/blob/main/package.json#L2-L3

{
    "name": "gitbook",
    "version": "0.1.0",
    "private": true,
    "scripts": {
        "dev": "next dev",
        "build": "next build",
        "build:cloudflare": "next-on-pages",
        "start": "next start",
        "lint": "next lint",
        "format": "prettier ./ --ignore-unknown --write",
        "format:check": "prettier ./ --ignore-unknown --list-different",
        "typecheck": "tsc --noEmit",
        "unit": "bun test {src,packages}/**/*.test.ts",
        "e2e": "playwright test",
        "postinstall": "rm -rf ./public/~gitbook/static/mathjax@3.2.2 && mkdir -p ./public/~gitbook/static/ && cp -R node_modules/mathjax/es5 ./public/~gitbook/static/mathjax@3.2.2"
    },
    "workspaces": [
        "packages/*"
    ],
    "dependencies": {
        "@geist-ui/icons": "^1.0.2",
        "@gitbook/api": "^0.36.0",
        "@radix-ui/react-checkbox": "^1.0.4",
        "@radix-ui/react-popover": "^1.0.7",
        "@sentry/nextjs": "^7.94.1",
        "@tailwindcss/container-queries": "^0.1.1",
        "@tailwindcss/typography": "^0.5.10",
        "@upstash/redis": "^1.27.1",
        "ajv": "^8.12.0",
        "assert-never": "^1.2.1",
        "bun-types": "^1.0.7",
        "content-security-policy-merger": "^1.0.0",
        "framer-motion": "^10.16.14",
        "js-cookie": "^3.0.5",
        "js-yaml": "^4.1.0",
        "jsontoxml": "^1.0.1",
        "katex": "^0.16.9",
        "memoizee": "^0.4.15",
        "next": "^14.1.3",
        "next-themes": "^0.2.1",
        "nuqs": "^1.15.4",
        "object-hash": "^3.0.0",
        "openapi-types": "^12.1.3",
        "p-map": "^7.0.0",
        "parse-cache-control": "^1.0.1",
        "react": "^18",
        "react-dom": "^18",
        "react-hotkeys-hook": "^4.4.1",
        "react-medium-image-zoom": "^5.1.10",
        "recoil": "^0.7.7",
        "rehype-sanitize": "^6.0.0",
        "rehype-stringify": "^10.0.0",
        "remark-parse": "^11.0.0",
        "remark-rehype": "^11.1.0",
        "rison": "^0.1.1",
        "server-only": "^0.0.1",
        "shiki": "^1.2.0",
        "swagger2openapi": "^7.0.8",
        "tailwind-merge": "^2.2.0",
        "tailwind-shades": "^1.1.2",
        "unified": "^11.0.4",
        "url-join": "^5.0.0",
        "mathjax": "^3.2.2",
        "classnames": "^2.5.1"
    },
    "devDependencies": {
        "@argos-ci/playwright": "^2.0.0",
        "@cloudflare/next-on-pages": "^1.9.0",
        "@cloudflare/workers-types": "^4.20231218.0",
        "@playwright/test": "^1.42.1",
        "@types/js-cookie": "^3.0.6",
        "@types/js-yaml": "^4.0.9",
        "@types/jsontoxml": "^1.0.5",
        "@types/jsonwebtoken": "^9.0.6",
        "@types/katex": "^0.16.5",
        "@types/node": "^20",
        "@types/object-hash": "^3.0.6",
        "@types/parse-cache-control": "^1.0.4",
        "@types/psi": "^4.1.6",
        "@types/react": "^18",
        "@types/react-dom": "^18",
        "@types/rison": "^0.0.9",
        "@types/swagger2openapi": "^7.0.4",
        "autoprefixer": "^10",
        "eslint": "^8",
        "eslint-config-next": "13.5.6",
        "eslint-plugin-import": "^2.29.0",
        "jsonwebtoken": "^9.0.2",
        "postcss": "^8",
        "prettier": "^3.0.3",
        "psi": "^4.1.0",
        "tailwindcss": "^3.4.0",
        "typescript": "^5"
    }
}

Test GitBook Open

Welcome

Long text thisisaveryyyylonnnnngwordthatisnotrealisic butit'sok

Empty page

Page options

Page no index

Descendant of page no index

Page no robots index

Descendant of page no robots index

Page with description

Page with cover

Page with dark cover

Page with cover and no TOC

Page with hero cover

Page with icon

Cake

Ice cream

Burger

Blocks

Annotations

In codeblocks

Integrations

Headings

Heading 1

Heading 2

Heading 3

Title 1

Title 2

Title 3

Expandables

Empty

With content

Marks

Colors

Emojis

Icons

Links

Links

A heading

Page links

API blocks

Math

Files

Embeds

Lists

Unordered list

Ordered list

Tasks

Mix

UL With blocks

List item starting with a heading

OL With blocks

List item starting with a heading

Tasks With blocks

List item starting with a heading

Stepper

First step

This is the first step

Columns

Expressions

Welcome

Page with icon

Headings

Heading 1

Heading 2

Heading 3

Title 1

Title 2

Title 3

Emojis

Emojis can also be used in headings!

Math

Emojis can also be used in headings!

Page links

Columns

Long text thisisaveryyyylonnnnngwordthatisnotrealisic butit'sok

Page no robots index

Page with description

Page no index

Descendant of page no robots index