All pages
Powered by GitBook
1 of 26

Blocks

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

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

  • And with a link !

With a divider:


After the divider

Tables

Basic text table

A1

B1

C1

A2

B2

C2

A3

B3

C3

With header

A
B
C

A1

B1

C1

A2

B2

C2

A3

B3

C3

With header hidden

A1

B1

C1

A2

B2

C2

A3

B3

C3

With resized column (B being larger)

A
B
C

A1

B1

C1

A2

B2

C2

A3

B3

C3

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

A
B
C

A1

B1

C1

Pasted right-aligned paragraph

Pasted right-aligned paragraph

Pasted right-aligned paragraph

Tables with different column types

Some intro text

A short oneA tag that is quite longAnother one

Short intro text

A short one

Another text

Another one

Table with full-width

A1

B1

C1

A2

B2

C2

A3

B3

C3

Table with ratings

Rating A
Rating B

R1

R2

R3

Table with files

Table with checkbox

Checkbox

Checked

Not checked

Checked

Table with content references

An image file

An openAPI file

No file

Link

Page

Text page

Page with emoji

Page with emoji

Page with icon

Page with icon
🌍

Headings

Heading 1

Heading 2

Heading 3

Title 1

Title 2

Title 3

Heading centered

This text is also centered

Heading on the right

This text is also right

Inline Images

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:

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:

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:

11x11

16x16

22x22

Images in links should not zoom when clicked, for example .

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 superscript and subscript.

Colors

Text colors:

  • Purple

  • Blue

  • Red

  • Orange

  • Yellow

  • Green

Background colors:

  • Purple

  • Blue

  • Red

  • Orange

  • Yellow

  • Green

Combined:

  • Purple

  • Blue

  • Red

  • Orange

  • Yellow

  • Green

Links

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

A heading

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 .

This is a . And this is a mention .

Icons

Buttons

With text alignment

Centeted:

On the right:

With icon

Page links

Link to another page

Link to a file

Link to another space

Link to a private space

Blocks
🌍Page with emoji
Page with icon

API blocks

A first block:

Webhooks :

Models:

Lists

Unordered list

  • First item

  • Second item

    • First nested item

      • Second nested item

  • Third item

Ordered list

  1. First item

  2. Second item

    1. First nested item

      1. Second nested item

  3. Third item

Tasks

Mix

  1. 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

  1. List item starting with a heading

    A paragraph below it.

  2. Text before code block

    code block
    a second line
  3. Directly, a code block

Tasks With blocks

20KB
openapi.yaml
16x16.png
openapi.yaml
A caption that is longer than the image to test how the images is being positioned relative to it.
A caption that is longer than the image to test how the images is being positioned relative to it.
A caption that is longer than the image to test how the images is being positioned relative to it.
16x16.png

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!

link to a different space
Public Changelog

Columns

Math

A math block that should render with KaTeX:

A math block that should be rendered 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:

f(x)=x∗e2piiξxf(x) = x * e^{2 pi i \xi x}f(x)=x∗e2piiξx

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

1(ϕ5−ϕ)e25π=1+e−2π1+e−4π1+e−6π1+e−8π1+⋯\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} } } }(ϕ5​​−ϕ)e52​π1​=1+1+1+1+1+⋯e−8π​e−6π​e−4π​e−2π​

Long inline math 1(ϕ5−ϕ)e25π=1+e−2π1+e−4π1+e−6π1+e−8π1+⋯1(ϕ5−ϕ)e25π=1+e−2π1+e−4π1+e−6π1+e−8π1+⋯1(ϕ5−ϕ)e25π=1+e−2π1+e−4π1+e−6π1+e−8π1+⋯1(ϕ5−ϕ)e25π=1+e−2π1+e−4π1+e−6π1+e−8π1+⋯1(ϕ5−ϕ)e25π=1+e−2π1+e−4π1+e−6π1+e−8π1+⋯1(ϕ5−ϕ)e25π=1+e−2π1+e−4π1+e−6π1+e−8π1+⋯\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} } } }(ϕ5​​−ϕ)e52​π1​=1+1+1+1+1+⋯e−8π​e−6π​e−4π​e−2π​(ϕ5​​−ϕ)e52​π1​=1+1+1+1+1+⋯e−8π​e−6π​e−4π​e−2π​(ϕ5​​−ϕ)e52​π1​=1+1+1+1+1+⋯e−8π​e−6π​e−4π​e−2π​(ϕ5​​−ϕ)e52​π1​=1+1+1+1+1+⋯e−8π​e−6π​e−4π​e−2π​(ϕ5​​−ϕ)e52​π1​=1+1+1+1+1+⋯e−8π​e−6π​e−4π​e−2π​(ϕ5​​−ϕ)e52​π1​=1+1+1+1+1+⋯e−8π​e−6π​e−4π​e−2π​

idinteger · int64optional
Example: 10
namestringrequired
Example: doggie
categoryobjectoptional

photoUrlsstring[]required
tagsobject[]optional

statusstring · enumoptional

pet status in the store

Options: available, pending, sold
link to a page in a public space
5 October: Theme-aware images, team owners and more

Finds Pets by status.

get

Multiple status values can be provided with comma separated strings.

Authorizations
Query parameters
statusstring · enum · default: "available"optional

Status values that need to be considered for filter

Options: available, pending, sold
Responses
cURL
JavaScript
Python
HTTP
200
400
default
application/json
application/xml

successful operation

Deletes a pet.

delete

Delete a pet.

Authorizations
Path parameters
petIdinteger · int64required

Pet id to delete

Header parameters
api_keystringoptional
Responses
cURL
JavaScript
Python
HTTP
200
400
default

No body

Pet deleted

Add a new pet to the store.

post

Add a new pet to the store.

Authorizations
Body
idinteger · int64optional
Example: 10
namestringrequired
Example: doggie
categoryobjectoptional

photoUrlsstring[]required
tagsobject[]optional

statusstring · enumoptional

pet status in the store

Options: available, pending, sold
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/api/v3/pet' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": 10,
    "name": "doggie",
    "category": {
      "id": 1,
      "name": "Dogs"
    },
    "photoUrls": [
      "text"
    ],
    "tags": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "status": "available"
  }'
200
400
422
default
application/json
application/xml
{
  "id": 10,
  "name": "doggie",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "text"
  ],
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "status": "available"
}

Successful operation

Update an existing pet.

put

Update an existing pet by Id.

Authorizations
Body
idinteger · int64optional
Example: 10
namestringrequired
Example: doggie
categoryobjectoptional

photoUrlsstring[]required
tagsobject[]optional

statusstring · enumoptional

pet status in the store

Options: available, pending, sold
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request PUT \
  --url '/api/v3/pet' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": 10,
    "name": "doggie",
    "category": {
      "id": 1,
      "name": "Dogs"
    },
    "photoUrls": [
      "text"
    ],
    "tags": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "status": "available"
  }'
200
400
404
422
default
application/json
application/xml
{
  "id": 10,
  "name": "doggie",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "text"
  ],
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "status": "available"
}

Successful operation

curl -L \
  --url '/api/v3/pet/findByStatus'
[
  {
    "id": 10,
    "name": "doggie",
    "category": {
      "id": 1,
      "name": "Dogs"
    },
    "photoUrls": [
      "text"
    ],
    "tags": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "status": "available"
  }
]
curl -L \
  --request DELETE \
  --url '/api/v3/pet/{petId}'