Writing docs

Docs are edited in the rich-text editor. Besides text, headings and lists, use the + menu to insert blocks.

Mermaid diagrams

Insert a Mermaid diagram block and write the chart in Mermaid syntax:

Insert an API operation block to show a single endpoint, with a working playground, inside a guide:

GET

/pet/{petId}

Returns a single pet.

petId*integer

ID of the pet to return

Formatint64

Successful operation

application/json

id?integer

Formatint64

name*string

category?

photoUrls*array<string>

status?string

pet status in the store

Value in"available""pending""sold"

curl -X GET 'https://petstore3.swagger.io/api/v3/pet/0'

{  "id": 10,  "name": "doggie",  "category": {    "id": 1,    "name": "Dogs"  },  "photoUrls": [    "string"  ],  "status": "available"}

Each page can set a Lucide icon, a separator heading shown above it, and whether its child pages start expanded.