1 of 26

Blocks

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

Annotations

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

In codeblocks

Tabs

A single tab:

Tab with content:

Hints

Colors

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

Integrations

A mermaid block:

A GitHub file:

A linear issue

A mailchimp block

Tables

Basic text table

With header

With header hidden

With resized column (B being larger)

With text alignment (A to the right, B centered, C to the left)

Tables with different column types

Table with full-width

Table with ratings

Rating A

Rating B

Table with files

Table with checkbox

Checkbox

Table with content references

Link

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

Headings

Heading 1

Heading 2

Expandables

Empty

This is an empty expandable (body)

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 .

Block Images

Large image

Alignment

Image centered:

An image on the left:

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.

Emojis

This text contains some 😇 emojis!!

Emojis can also be used in 🎉 headings!

Diversity: 👩

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

Icons

This text contains some icons!!

Icons can also be used in headings!

Buttons

Some text with a button Primary button and Secondary

2 buttons next to each other: Button 1Button 2

With text alignment

Centeted:

New button

On the right:

New button

With icon

A button with an icon:

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:

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} } } }$

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

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

Left hand side!

Right hand side!

Test different widths

Expressions

TEST_1: This is the value of TEST_1

TEST_2: This is the value of TEST_2

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.

Blocks

Code

Code block with lines and no wrapping

Code block with line numbers and wrapping

Code block with wrapping but no line numbers

Code block with full-width option

Annotations

In codeblocks

Tabs

Hints

Colors

Integrations

Tables

Cards

Headings

Heading 1

Heading 2

Expandables

Empty

Inline Images

Block Images

Large image

Alignment

Marks

Emojis

Emojis can also be used in 🎉 headings!

Icons

Icons can also be used in headings!

Links

Links

A heading

Buttons

With text alignment

With icon

Page links

API blocks

Math

Files

Embeds

Lists

Unordered list

Stepper

First step

This is the first step

Columns

Expressions

Blocks

Expressions

Inline Images

Stepper

First step

This is the first step

Embeds

Annotations

In codeblocks

Tabs

Hints

Colors

First heading

Second heading

Links & tabs

Icons

Icons can also be used in headings!

Emojis

Emojis can also be used in 🎉 headings!

With blocks in it

Links

Links

A heading

Lists

Unordered list

Block Images

Large image

Alignment

Files

Ordered list

Tasks

Mix

UL With blocks

List item starting with a heading