Blocks

Loading...

Code

Code block with lines and no wrapping

function CodeHighlightLine(props: {
    block: DocumentBlockCode;
    line: HighlightLine;
    lineIndex: number;
    isLast: boolean;
    withLineNumbers: boolean;
    withWrap: boolean;
    context: ContentRefContext;
}) {
    const { block, line, isLast, withLineNumbers, context } = props;

    return (
        <span
            className={tcls(
                'flex',
                'flex-row',
                'px-4',
                line.highlighted ? 'bg-slate-200' : null,
                withLineNumbers
                    ? [
                          'before:shrink-0',
                          'before:absolute',
                          'before:left-0',
                          'before:pl-4',
                          line.highlighted ? 'before:bg-slate-200' : 'before:bg-slate-100',
                          'before:text-slate-400',
                          'before:content-[counter(line)]',
                          '[counter-increment:line]',
                          getLineNumberGutterWidth(block),
                      ]
                    : [],
            )}
        >
            <span className="flex-1">
                <CodeHighlightTokens tokens={line.tokens} context={context} />
                {isLast ? null : !withLineNumbers && line.tokens.length === 0 && 0 ? (
                    <span className="ew">{'\u200B'}</span>
                ) : (
                    '\n'
                )}
            </span>
        </span>
    );
}

Code block with line numbers and wrapping

function CodeHighlightLine(props: {
    block: DocumentBlockCode;
    line: HighlightLine;
    lineIndex: number;
    isLast: boolean;
    withLineNumbers: boolean;
    withWrap: boolean;
    context: ContentRefContext;
}) {
    const { block, line, isLast, withLineNumbers, context } = props;

    return (
        <span
            className={tcls(
                'flex',
                'flex-row',
                'px-4',
                line.highlighted ? 'bg-slate-200' : null,
                withLineNumbers
                    ? [
                          'before:shrink-0',
                          'before:absolute',
                          'before:left-0',
                          'before:pl-4',
                          line.highlighted ? 'before:bg-slate-200' : 'before:bg-slate-100',
                          'before:text-slate-400',
                          'before:content-[counter(line)]',
                          '[counter-increment:line]',
                          getLineNumberGutterWidth(block),
                      ]
                    : [],
            )}
        >
            <span className="flex-1">
                <CodeHighlightTokens tokens={line.tokens} context={context} />
                {isLast ? null : !withLineNumbers && line.tokens.length === 0 && 0 ? (
                    <span className="ew">{'\u200B'}</span>
                ) : (
                    '\n'
                )}
            </span>
        </span>
    );
}

Code block with wrapping but no line numbers

Code block with full-width option

Loading...

Annotations

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

In codeblocks

// Some code
and an .

Loading...

Tabs

A single tab:

Tab with content:

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.

This tab contains headings that can be linked to:

First heading

Content

Second heading

Content

Tab with many long tab titles:

Links & tabs

Individual tabs can be linked or .

Loading...

Hints

Colors

Info hints are great for showing general information, or providing tips and tricks.

Success hints are good for showing positive actions or achievements.

Warning hints are good for showing important information or non-critical warnings.

Danger hints are good for highlighting destructive actions or raising attention to critical information.

With blocks in it

First paragraph

Second paragraph

List item
Second list item

With a divider:

After the divider

Loading...

Integrations

A mermaid block:

A GitHub file:

A linear issue

A mailchimp block

Loading...

Tables

Basic text table

With header

A

Loading...

Cards

2 basic cards with text:

Cards with cover

Cards with centered text and images

Cards with different column types

Cards full-width

Cards with different column types and headers

Intro text

Enum values

Intro text

Enum values

Intro text

Enum values

Loading...

Headings

Heading 1

Heading 2

Loading...

Expandables

Empty

This is an empty expandable (body)

Loading...

Inline Images

his paragraph contains inline images, this first one was using the "original" size, and then this one is using the line size.

This image has intrinsic 400px width, but renders as 300px:

Some customers add Cards with inline images instead of Cover images. When they do, we should still respect the 300px width despite the Card being under 250px. The contents of the images should be centered.

Finally, we should make sure to render tiny inline images correctly:

11x11

16x16

22x22

Images in links should not zoom when clicked, for .

Loading...

Block Images

Large image

Alignment

Image centered:

An image on the left:

An image on the right:

Alignment with caption

Image centered:

An image on the left:

An image on the right:

Loading...

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

Background colors:

Purple
Blue
Red
Orange

Combined:

Purple
Blue
Red
Orange

Loading...

Emojis

This text contains some 😇 emojis!!

Emojis can also be used in 🎉 headings!

Diversity: 👩

And other emojis: man detective🕵️, women detective🕵️‍♀️

Loading...

Icons

This text contains some icons!!

Icons can also be used in headings!

Loading...

Links

This is a link to a heading. This is a mention of a heading A heading.

This is a link to a heading in a different page. And this a mention Heading 3.

This is a link to a page. And this is a mention: Text page

This is a link to the current space. And this is a mention Test GitBook Open

This is a (public). And this is a mention

This is a . And this is a mention

This is a . And this is a mention .

A heading

Loading...

Buttons

Some text with a button and

2 buttons next to each other:

With text alignment

Centeted:

On the right:

Loading...

Page links

Link to another page

Link to a file

20KB

openapi.yaml

Link to another space

Link to a private space

Loading...

API blocks

A first block:

Webhooks :

Models:

Loading...

Math

A math block that should render with KaTeX:

f(x) = x * e^{2 pi i \xi x}

A math block that should be rendered with MathJax:

σ_{i,BTC} =min($9600,\text{ } $2500)

A math inline with KaTex: $f(x) = x * e^{2 pi i \xi x}$ and one with MathJax σ_{i,BTC} =min($9600,\text{ } $2500)

Another one with MathJax:

\text{Hourly Funding Payment} = \text{Position Notional Value} \times \text{Funding Rate}\

And a bigger one with KaTeX:

\displaystyle \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } }

Long inline math $\displaystyle \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } } \displaystyle \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } } \displaystyle \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } } \displaystyle \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } } \displaystyle \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } } \displaystyle \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } }$

Loading...

Files

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

File blocks can also have a caption:

Loading...

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

Loading...

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

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

OL With blocks

List item starting with a heading
A paragraph below it.
Text before code block

Tasks With blocks

List item starting with a heading
A paragraph below it.
Text before code block

Loading...

Stepper

1

First step

Content of the step

With another line, and an image

2

Second step

This is the second step

3

This is the first step

And it's good!

Loading...

Columns

Left hand side!

Middle column

Right hand side!

Test different widths