Example Blocks#

Output:

shape: (3, 7) ┌──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬───────┬──────┬──────┬──────┐ │ col1 ┆ col2 ┆ col3 ┆ col3 ┆ col3 ┆ col3 ┆ col3 ┆ col3 ┆ col3 ┆ col3 ┆ col3 ┆ col3 ┆ col3 ┆ col3 ┆ col3 ┆ col3 ┆ col4 ┆ col5 ┆ col6 ┆ col7 │ │ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- │ │ i64 ┆ str ┆ f64 ┆ f64 ┆ f64 ┆ f64 ┆ f64 ┆ f64 ┆ f64 ┆ f64 ┆ f64 ┆ f64 ┆ f64 ┆ f64 ┆ f64 ┆ f64 ┆ bool ┆ i64 ┆ str ┆ f64 │ ╞══════╪══════╪══════╪══════╪══════╪══════╪══════╪══════╪══════╪══════╪══════╪══════╪══════╪══════╪══════╪══════╪═══════╪══════╪══════╪══════╡ │ 1 ┆ a ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ true ┆ 100 ┆ x ┆ 0.1 │ │ 1 ┆ a ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ true ┆ 100 ┆ x ┆ 0.1 │ │ 1 ┆ a ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ true ┆ 100 ┆ x ┆ 0.1 │ │ 1 ┆ a ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ true ┆ 100 ┆ x ┆ 0.1 │ │ 1 ┆ a ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ true ┆ 100 ┆ x ┆ 0.1 │ │ 1 ┆ a ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ true ┆ 100 ┆ x ┆ 0.1 │ │ 1 ┆ a ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ true ┆ 100 ┆ x ┆ 0.1 │ │ 2 ┆ b ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ false ┆ 200 ┆ y ┆ 0.2 │ │ 1 ┆ a ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ true ┆ 100 ┆ x ┆ 0.1 │ │ 1 ┆ a ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ true ┆ 100 ┆ x ┆ 0.1 │ │ 1 ┆ a ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ true ┆ 100 ┆ x ┆ 0.1 │ │ 2 ┆ b ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ false ┆ 200 ┆ y ┆ 0.2 │ │ 2 ┆ b ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ false ┆ 200 ┆ y ┆ 0.2 │ │ 2 ┆ b ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ false ┆ 200 ┆ y ┆ 0.2 │ │ 2 ┆ b ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ false ┆ 200 ┆ y ┆ 0.2 │ │ 2 ┆ b ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ false ┆ 200 ┆ y ┆ 0.2 │ │ 2 ┆ b ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ false ┆ 200 ┆ y ┆ 0.2 │ │ 2 ┆ b ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ false ┆ 200 ┆ y ┆ 0.2 │ │ 1 ┆ a ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ true ┆ 100 ┆ x ┆ 0.1 │ │ 1 ┆ a ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ true ┆ 100 ┆ x ┆ 0.1 │ │ 1 ┆ a ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ true ┆ 100 ┆ x ┆ 0.1 │ │ 1 ┆ a ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ 10.5 ┆ true ┆ 100 ┆ x ┆ 0.1 │ │ 2 ┆ b ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ false ┆ 200 ┆ y ┆ 0.2 │ │ 2 ┆ b ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ false ┆ 200 ┆ y ┆ 0.2 │ │ 2 ┆ b ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ false ┆ 200 ┆ y ┆ 0.2 │ │ 2 ┆ b ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ false ┆ 200 ┆ y ┆ 0.2 │ │ 2 ┆ b ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ false ┆ 200 ┆ y ┆ 0.2 │ │ 2 ┆ b ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ 20.1 ┆ false ┆ 200 ┆ y ┆ 0.2 │ │ 3 ┆ c ┆ 30.2 ┆ 30.2 ┆ 30.2 ┆ 30.2 ┆ 30.2 ┆ 30.2 ┆ 30.2 ┆ 30.2 ┆ 30.2 ┆ 30.2 ┆ 30.2 ┆ 30.2 ┆ 30.2 ┆ 30.2 ┆ true ┆ 300 ┆ z ┆ 0.3 │ └──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴───────┴──────┴──────┴──────┘

smaller scrollbar

Output:

┌──────┬──────┬──────┬───────┬──────┬──────┬──────┐ │ col1 ┆ col2 ┆ col3 ┆ col4 ┆ col5 ┆ col6 ┆ col7 │ │ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- │ │ i64 ┆ str ┆ f64 ┆ bool ┆ i64 ┆ str ┆ f64 │ ╞══════╪══════╪══════╪═══════╪══════╪══════╪══════╡ │ 1 ┆ a ┆ 10.5 ┆ true ┆ 100 ┆ x ┆ 0.1 │ │ 2 ┆ b ┆ 20.1 ┆ false ┆ 200 ┆ y ┆ 0.2 │ │ 3 ┆ c ┆ 30.2 ┆ true ┆ 300 ┆ z ┆ 0.3 │ └──────┴──────┴──────┴───────┴──────┴──────┴──────┘

Empty blocks are not going to be exported

Sql Blocks#

1
print("hello world")
2
-- %%sql --save not_nulls --no-execute
3
-- %%sql --save not_nulls --no-execute
4

5
SELECT *
6
FROM penguins.csv
7
WHERE bill_length_mm IS NOT NULL
8
AND bill_depth_mm IS NOT NULL
9

10
%sqlplot boxplot --column bill_length_mm bill_depth_mm --table not_nulls

Code Blocks with mdparams and Attributes folded#

The next block has complex :mdparams and other attributes. The filter should:

Put js as the language
Inline all attributes into the fence header
Leave attribute order and values intact

5 collapsed lines
function demo() {
  // Mark any given text inside lines
  return 'Multiple matches of the given text are supported';
}
echo "Test" > /home/test.txt
// All this boilerplate setup code will be collapsed
import { someBoilerplateEngine } from '@example/some-boilerplate'
import { evenMoreBoilerplate } from '@example/even-more-boilerplate'

Here is some simple JavaScript code with :del and :ins attributes:

1
console.log('This code is syntax highlighted!')

Here is a separator to visually break sections in the output:

Code block attributes are transferred as-is from Org header args:

1
console.log('Title attribute example')

This line mimics a “title” attribute in the rendered Markdown:

js title”my-test-file.js”

Shell code block without any special attributes:

1
echo "This terminal frame has no title"

Diff block that should be highlighted as JavaScript due to :lang js:

1
function thisIsJavaScript() {
2
  // This entire block gets highlighted as JavaScript,
3
  // and we can still add diff markers to it!
4
  console.log('Old code to be removed')
5
  console.log('New and shiny code!')
6
}

A block that uses :mdparams "given text" to mark text inside lines:

1
function demo() {
2
  // Mark any given text inside lines
3
  return 'Multiple matches of the given text are supported';
4
}

Jupyter / Session-Based Code and Example Output ATTACH#

Jupyter-like block with a Python session and simple text output:

1
print("hi there")

Output:

hi there

More complex Jupyter block that produces a table-like textual result and an image:

1
import matplotlib.pyplot as plt
2
import polars as pl
3

4
df = pl.DataFrame({
5
    "col1": [1, 2, 3],
6
    "col2": ["a", "b", "c"],
7
    "col3": [10.5, 20.1, 30.2],
8
    "col4": [True, False, True],
9
    "col5": [100, 200, 300],
10
    "col6": ["x", "y", "z"],
11
    "col7": [0.1, 0.2, 0.3],
12
})
13

14
print(df)

Output:

shape: (3, 7) ┌──────┬──────┬──────┬───────┬──────┬──────┬──────┐ │ col1 ┆ col2 ┆ col3 ┆ col4 ┆ col5 ┆ col6 ┆ col7 │ │ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- ┆ --- │ │ i64 ┆ str ┆ f64 ┆ bool ┆ i64 ┆ str ┆ f64 │ ╞══════╪══════╪══════╪═══════╪══════╪══════╪══════╡ │ 1 ┆ a ┆ 10.5 ┆ true ┆ 100 ┆ x ┆ 0.1 │ │ 2 ┆ b ┆ 20.1 ┆ false ┆ 200 ┆ y ┆ 0.2 │ │ 3 ┆ c ┆ 30.2 ┆ true ┆ 300 ┆ z ┆ 0.3 │ └──────┴──────┴──────┴───────┴──────┴──────┴──────┘

See go to section two

1
import matplotlib.pyplot as plt
2
x = [1, 2, 3, 4]
3
y = [2, 4, 6, 8]
4
plt.plot(x, y)
5
plt.savefig('output.svg')
6

7
# import polars as pl
8

9
# df = pl.DataFrame({
10
#     "col1": [1, 2, 3],
11
#     "col2": ["a", "b", "c"],
12
#     "col3": [10.5, 20.1, 30.2],
13
#     "col4": [True, False, True],
14
#     "col5": [100, 200, 300],
15
#     "col6": ["x", "y", "z"],
16
#     "col7": [0.1, 0.2, 0.3],
17
# })
18

19
# print(df)

Output:

1
import duckdb
2
duckdb.sql("""SELECT *,
3
  CASE WHEN n % 2 = 0 THEN 'Even' ELSE 'Odd' END AS parity
4
FROM (SELECT * FROM generate_series(1, 10000000) AS t(n))
5
WHERE n % 99999 = 0 LIMIT 4;""").show()

Output:

┌────────┬─────────┐ │ n │ parity │ │ int64 │ varchar │ ├────────┼─────────┤ │ 99999 │ Odd │ │ 199998 │ Even │ │ 299997 │ Odd │ │ 399996 │ Even │ └────────┴─────────┘