mdslides-typst

Convert Markdown files to PDF slides presentations, using typst and typeslides.

Usage

Command Line

# Basic usage
mdslides your_presentation.md

# Specify output typst file
mdslides your_presentation.md --no-compile -o custom_output.typ

As a Library

from mdslides import convert_markdown_to_typst

# Read markdown content
with open("your_presentation.md", "r") as f:
    markdown_content = f.read()

# Convert to typst
typst_content = convert_markdown_to_typst(
    markdown_content,
    title="My Presentation",
    subtitle="A great presentation",
    author="Your Name",
    info="2025-03-29"
)

# Save the output
with open("presentation.typ", "w") as f:
    f.write(typst_content)

Markdown Format

• Use front matter to specify presentation metadata
• Use # (H1) to define sections (will create a section slide with the header text)
• Use ## (H2) for content slides

Example:

---
title: My Presentation
subtitle: A subtitle
author: Your Name
date: 2025-03-29
---

# Introduction

This is a section slide.

## First Content Slide

- This is bullet point 1
- This is bullet point 2

## Second Content Slide

**Bold text** and *italic text*

Requirements

• Python 3.12+
• typst