Documentation

Texts

Texts can be used to describe all kinds of details about your data science projects.
You can use the well-known markdown syntax to format and structure your texts.

Headings

Prefix a line with 1-6 hashes to make it a header.

Headings Syntax

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5

Heading 6

Paragraphs

Paragraphs are separated by two empty lines.

Paragraphs Syntax

Paragraph 1

Paragraph 2

Paragraph 3

Line Breaks

Force a line break by adding two whitespaces at the end of a line.

Line Breaks Syntax

Line 1 Line 2 Line 3

Italic

Enclose a text with single stars to make it italic.

Italic Syntax

Text

Bold

Enclose a text with double stars to make it bold.

Bold Syntax

Text

Strikethrough

Enclose a text with double tildes to strike it through.

Strikethrough Syntax

~~Text~~

Links

Link Syntax

Diafunc

Autolinks

Bare URLs and email addresses are automatically converted to clickable links.

Autolink Syntax

Visit https://diafunc.com or email support@diafunc.com .

Images

Image Syntax

Quotes

Quote Syntax

Quote

Inline code

Wrap a span of text in single backticks to render it as inline code.

Inline Code Syntax

Set the variable threshold to a value between 0 and 1 .

Code

Wrap a block of text in triple-backtick fences to render it as a code block. The first line after the opening fence may name the language for syntax highlighting.

Code Syntax

Unordered Lists

Unodered List Syntax

Item 1
Item 2
Item 3

Ordered Lists

Ordered List Syntax

Item 1
Item 2
Item 3

Nested Lists

Nested List Syntax

A
- A1
- A2
- A3
B
- B1
- B2
- B3
C
- C1
- C2
- C3

X 1.1. X1 1.2. X2 1.3. X3
Y 2.1. Y1 2.2. Y2 2.3. Y3
Z 3.1. Z1 3.2. Z2 3.3. Z3

A
1. A1
2. A2
3. A3
B
1. B1
2. B2
3. B3
C
1. C1
2. C2
3. C3

Tables

Table Syntax

A	B	C
1	2	3
4	5	6
7	8	9
10	11	12

Task lists

Mark list items as todo / done with - [ ] and - [x].

Task List Syntax

Collect dataset
Run baseline model
Compare against ensemble
Write up findings

Math

Wrap LaTeX-style math in single dollars for inline, or double dollars on their own lines for block.

Inline Math Syntax

Energy is $E = m c^{2}$ in a vacuum.

Block Math Syntax

The integral

\int_{0}^{1} x d x = \frac{1}{2}

is one of the simplest.

Footnotes

Reference a footnote with [^id] and define it elsewhere with [^id]: text. Footnotes are numbered in first-seen order and collected at the end of the text.

Footnote Syntax

Symbolic regression ¹ differs from neural approaches ² .

It searches over closed-form expressions, not weights.
↩
Neural networks learn weights of a fixed architecture.
↩

Entity references

Link to a function, table, or model in the same project with [[type:entityId]]. The reference resolves to a clickable link with the entity's icon and name.

Entity Reference Syntax

Reference an entity in another project by prefixing the project ID:

Cross-Project Reference Syntax

Pin a specific project branch and entity branch with @branch, and override the link label with |My Label:

Branches and Custom Label Syntax

Entity embeds

Prefix the reference with ! to embed an entity as a card. When the embed is the only content on a paragraph, it renders block-level. For function, table, and model entities the embed also includes a live, read-only preview of the entity's content below the header — its source code (function), its data grid (table), or its dossier (model). Click the header to open the full entity in the lab.

Function Embed Syntax

Table Embed Syntax

Model Embed Syntax

Section anchors

Headings get an automatically-generated id based on a kebab-case slug of their text. Link to a section in the same text with [[#section-slug]], optionally with a label [[#section-slug|Custom Label]]. Standard markdown anchor links [Title](#section-slug) work too.

Section Anchor Syntax

Notebook cell anchors

Inside a notebook, link to a specific cell with [[#cell:entityId]]. The default branch is main; pin a different branch with [[#cell:entityId/branch]]. Custom label override |Label works as with all other wiki forms.

Cell Anchor Syntax

What next?

Statistics