Enscribe
Open in playground ↗
Notation

Foreign formal-language content a DSL owns — mathematics and code, embedded when small and exhibited when large.

<align> General Usage

Semantic role: align. Compiles to eHTML <align>.

Registers:

  • Canonical: <align>
<align>
x^2 + y^2 &= z^2 \\
a + b &= c
</align>
(1)
Minipage 105.

Two aligned equations. The &amp; marks the alignment column (here, the = sign). Handler wraps in \begin{aligned}...\end{aligned} (KaTeX-compatible variant of LaTeX’s align).

<cases> General Usage

Semantic role: cases. Compiles to eHTML <cases>.

Registers:

  • Canonical: <cases>
<cases>
x^2 & \text{if } x \ge 0 \\
-x^2 & \text{if } x < 0
</cases>
(1)
Minipage 106.

A two-case piecewise definition. Handler wraps in \begin{cases}...\end{cases}.

<code> General Usage

Semantic role: code. Compiles to eHTML <code>.

Registers:

  • Canonical: <code>
The function is `factorial`.

The function is factorial.

Minipage 107.

Plain markdown backticks produce inline <code>. The most common authoring path.

Use `<`code`>` for inline code.

Use <code> for inline code.

Minipage 108.

The enscribe sigil form. Equivalent to plain markdown backticks but supports attributes.

<code language=python | def hello(): print("hi")>
def hello(): print("hi")
Minipage 109.
<code #factorial-impl language=python | def factorial(n):>
def factorial(n):
Minipage 110.
 Arguments
attribute kind values / default notes
language kwarg The programming language of the code.
src kwarg An @id reference (#313 consumer wiring) that pulls a stored <dataset> declared in <data> and renders its opaque bytes as the verbatim code body — e.g.
<code-block> General Usage

Semantic role: code-block. Compiles to eHTML <code-block>.

Registers:

  • Canonical: <code-block>
<``` python | print("hello, world") ```> 
 print("hello, world")
Minipage 111.

The triple-backtick sigil. The first positional token is the language (emitted as a language-X class on the <code>); the pipe separates it from the verbatim, whitespace-preserving content — the pipe-form padding (the spaces around the content) is KEPT, since whitespace in code is significant and visible to the reader. (#327)

<``` this is all content ```> 
 this is all content
Minipage 112.

The no-pipe form: the entire body is opaque content with no language extraction.

 Arguments
attribute kind values / default notes
src kwarg An @id reference (Option A / #313) that pulls a stored <dataset> declared in <data> and renders its opaque bytes as the code block’s verbatim body — e.g.
<display-math> General Usage

Semantic role: display-math. Compiles to eHTML <display-math>.

Registers:

  • Canonical: <display-math>
<$$ \sum_{i=1}^{n} x_i = X $$>
(1)
Minipage 113.

The $$ sigil. Display-mode LaTeX rendered by KaTeX on its own line; numbered by default (the equation number is appended after the KaTeX output).

 Arguments
attribute kind values / default notes
+numbered / -numbered flag default on Whether this equation participates in the document-wide numbered sequence.
<eqnarray> General Usage

Semantic role: eqnarray. Compiles to eHTML <eqnarray>.

Registers:

  • Canonical: <eqnarray>
<eqnarray>
f(x) &=& x^2 \\
g(x) &=& 2x
</eqnarray>
(1)
Minipage 114.

Two equations rendered via KaTeX’s aligned env (the supported equivalent of LaTeX’s eqnarray).

<inline-code> General Usage

Semantic role: inline-code. Compiles to eHTML <inline-code>.

Registers:

  • Canonical: <inline-code>
Assign with <` x = 1 `> at the top of the function.

Assign with x = 1 at the top of the function.

Minipage 115.

The single-backtick sigil. With no pipe, the whole body is opaque code content rendered as <code> (the same output as a markdown backtick span). Whitespace in code is significant and preserved, so the pipe-form padding stays INSIDE the <code>. (#327)

Call <` python | factorial(n) `> to recurse.

Call factorial(n) to recurse.

Minipage 116.

The first positional token before the pipe is the language, emitted as a language-X class on the <code> (discoverable by highlighters; the interpreter applies no highlighting itself).

<inline-math> General Usage

Semantic role: inline-math. Compiles to eHTML <inline-math>.

Registers:

  • Canonical: <inline-math>
The identity <$ a^2 + b^2 = c^2 $> holds for right triangles.

The identity holds for right triangles.

Minipage 117.

The $ sigil. Opaque LaTeX content rendered inline by KaTeX and wrapped in <inline-math> for CSS targeting. The sigil carries no attributes — id and classes are not supported for inline math.

<math> General Usage

Semantic role: math. Compiles to eHTML <math>.

Registers:

  • Canonical: <math>
<math>
E = mc^2
</math>
(1)
Minipage 118.

Long-form &lt;math&gt; block. Semantically equivalent to the &lt;$$ E = mc^2 $$&gt; display-math sigil — both render block-level LaTeX math via KaTeX. Use the long-form when the source is multi-line or when explicit tag bounds aid readability; use the sigil for brevity.

<matrix> General Usage

Semantic role: matrix. Compiles to eHTML <matrix>.

Registers:

  • Canonical: <matrix>
<matrix>
1 & 2 \\
3 & 4
</matrix>
(1)
Minipage 119.

A 2×2 matrix. The handler wraps the body in \begin{matrix}...\end{matrix} before KaTeX renders.