Skip to content

Doc page

Doc page is one of the notebook page types. It's a flow-based block editor, used for analysis by arranging SQL blocks, charts, text, and more vertically. You can use the following blocks within a page. While editing, type / to choose from a list of available blocks.

See Grid page for dashboard-style tile layouts. Charts and SQL run results placed on a grid page are first defined on a doc page.

Key features

  • A flow-based block editor (arrange SQL blocks, charts, text, and more)
  • SQL block: SQL editing, execution, result display, and chart creation
  • Parameter: an input form at the top of the page and embedding in SQL
  • Chart: visualizing SQL block run results
  • Explorer: exploring data through a GUI
  • Full-text search

Available blocks

The blocks available on a doc page are grouped as follows. You can select one while editing by typing /, or from Add in a block's hover menu.

Data analysis

BlockDescription
SQL blockUsed for SQL editing and execution, showing run results, column statistics, and chart creation.
Table previewShows sample rows from a table on a connection within the page. You can also launch Explorer from it.
Block chartVisualizes the run result of a SQL block on the same page as a chart. In addition to placing it as a vertical block, you can convert it to an inline chart and place it within a list or text table.
Scalar value referenceEmbeds the value of a specified column from the first row of a SQL block's run result on the same page, directly within text.

Code

BlockDescription
Code blockDisplays code with syntax highlighting.
Diagram blockRenders a diagram in Mermaid format.
Block equationDisplays a formula in KaTeX format. Inline formulas within text are also supported.

Text

BlockDescription
Heading 1 / Heading 2 / Heading 3Headings within the page (3 levels).
Bulleted listA list with bullet markers.
Ordered listA numbered list.
Task listA list that can track completion state.
Togglable listA list you can expand and collapse.
DividerA horizontal line.
Callout blockEmphasizes content by type (info, success, warning, danger). You can also specify an emoji icon.
Quote blockA quote. It can only contain paragraphs or lists.
Text tableA table whose cells can contain paragraphs or lists. Supports cell merging and column width settings.

Layout

BlockDescription
2 columns / 3 columns / 4 columns / 5 columnsA multi-column layout. Each column can contain paragraphs, lists, and charts (SQL blocks and similar can't be placed).

Media

BlockDescription
Image / VideoPlace a file by selecting or pasting it into the page.
Link notebookA link to another notebook. You can also add it by pasting a URL.
Embed blockEmbeds external content from a supported URL, such as YouTube. You can also add it by pasting a URL.
EmojiSelect and insert an emoji from a picker.