Notebook (::notebook)

↑ Docs content model

The ::notebook directive embeds a Databricks notebook into the page.

When to use

Use ::notebook to embed an exported, runnable notebook — typically in a tutorial or example — so readers can see and import the full working code.

Technical details

Markdown

::notebook[Optional Title]{file=<file>}

The filepath is relative to the docs/web/static/notebooks/source directory.

Rules

• The file attribute is required and is resolved relative to docs/web/static/notebooks/source.
• The title in square brackets is optional.

Style

• Give the notebook a descriptive title so readers know what it does before opening it.

Template

Markdown

::notebook[Optional title]{file="notebook.html"}

Examples

Example:

Markdown

::notebook[title for my notebook]{file="gcs-read-scala.html"}

Output:

title for my notebook

Open notebook in new tabOpen in Databricks

Used in

Content atoms appear in any page section. Embedded notebooks are common in the Tutorial page type and in Procedure sections that ship runnable code.