Markdown content

Pointing md= at a Markdown file fills a slide's zones with its content:

from inkflow import Deck, Slide


def main() -> Deck:
    return Deck(
        slides=[
            Slide("content", md="intro"),
        ]
    )

md takes the same kind of reference as Slide.src. A bare name like "intro" resolves to slides/intro.md, or you can write out a full path. Inline("# Title\n\nBody") passes Markdown directly instead of reading a file.

Here "content" happens to be a built-in layout, but nothing about md= requires one. It fills whatever zones the referenced SVG defines.

Where the content goes

inkflow routes a Markdown file into zones in two ways.

Automatic

With no markers at all:

• a leading # H1 goes to zone-title
• an ## H2 immediately after it goes to zone-subtitle
• everything else goes to the default zone

# My slide title
## Optional subtitle

The body content goes here.

Explicit markers

::zone-name:: routes everything after it to that zone, until the next marker:

::left::

## Left column

Content for the left side.

::right::

## Right column

Content for the right side.

Explicit markers always win over the automatic routing.

Alignment inside a zone

Zone markers take optional key=value parameters:

::content align=center valign=center padding=60::

Horizontally and vertically centered, with 60 units of padding.

Parameter	Values	Controls
align	left, center, right, justify	Horizontal text alignment
valign	top, center, bottom	Vertical position of the content block
padding	number, in SVG user units	Inner spacing on all sides

All three are optional and combine freely.

These are the most specific of three layers. A marker parameter beats a CSS variable set in the layout SVG, which beats the built-in default (left, top, 0):

/* in the layout SVG's <defs><style> — applies to every slide using it */
#zone-title   { --inkflow-valign: center; }
#zone-content { --inkflow-padding: 40px; }

From deck.py, pass align, valign and padding to TextBox instead.

Revealing content in steps

::step:: and ::steps:: split a zone into chunks that appear on successive keypresses. They share one timeline with the slide's animations, so they are covered together on Steps.

Code blocks

Fenced code blocks are syntax-highlighted automatically with Pygments. Write a standard fence with a language tag, and nothing else is needed:

```python
def greet(name: str) -> str:
    return f"Hello, {name}!"
```

A {…} spec after the language name walks the block line by line as you advance, which is a step feature: see code walkthroughs.

Images

Standard Markdown syntax works:

![A diagram](assets/diagram.png)

A path resolves relative to the file it is written in. This is what every editor already assumes, so there is no separate convention:

Reference in	Points at
 in slides/intro.md	slides/assets/diagram.png
<image href="../assets/diagram.png"> in slides/intro.svg	assets/diagram.png
Image("assets/diagram.png") in deck.py	assets/diagram.png

A slide SVG keeps rendering in Inkscape and a Markdown file keeps previewing in your editor.

The file itself must live inside the project directory, or inside the active theme's asset directory. Anything outside both cannot be served or exported, and is reported as a warning naming the file and the reference. To use a directory elsewhere, symlink it in:

ln -s ../shared/assets assets

Local files are copied into the output of inkflow build and inkflow export. Remote https:// and data: URIs are left alone.

Linking to another slide

A link with the slide: scheme jumps to the slide with that id:

See the [architecture overview](slide:overview) for the full picture.

Clicking it cuts straight to that slide at its first step, and the browser's Back button returns you.

A slide's id is inferred from its .md filename, or from the src filename when there is no Markdown, and you can set it explicitly:

Slide("diagram", md="architecture", id="overview")

IDs must be unique across the deck. Collisions get -2, -3 appended. A link to an id that does not exist is left inert.

Speaker notes

::notes:: routes everything after it to the speaker notes rather than onto the slide:

# My slide title

The visible slide body goes here.

::notes::

These are my private notes. They support **Markdown** and appear
only in the presenter panel.

You can also set notes from deck.py:

from inkflow import Inline, Slide

Slide("title", notes=Inline("Remember to greet the audience."))
Slide("content", md="bullets", notes="notes/bullets.md")

A bare str is a path, Inline(...) is the text itself. Either way the content is rendered as Markdown. When a slide has both notes= and a ::notes:: marker, the two are concatenated, notes= first.

Notes show in the presenter panel.