Skip to main content

Convert Markdown to PDF slides using Typst and typslides

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mdslides_typst-0.1.2.tar.gz (11.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mdslides_typst-0.1.2-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file mdslides_typst-0.1.2.tar.gz.

File metadata

  • Download URL: mdslides_typst-0.1.2.tar.gz
  • Upload date:
  • Size: 11.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mdslides_typst-0.1.2.tar.gz
Algorithm Hash digest
SHA256 ec57b1a0023b8fb3c02c70a53735c4046780c98d2ad9bc40b0ea42100f596e8a
MD5 23bd0d2da33ddcb6618b561a37b013be
BLAKE2b-256 6af220fee7b9b4b1176abc6a913c78902e96e9154086c95a83a7c9778edd470e

See more details on using hashes here.

Provenance

The following attestation bundles were made for mdslides_typst-0.1.2.tar.gz:

Publisher: python-publish.yml on cavenditti/mdslides-typst

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mdslides_typst-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: mdslides_typst-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mdslides_typst-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 bc76ef95c3513e0472943ed560ba6ef6850243342707fbc03631645e793b9aef
MD5 09b8940f5c30c2f7b39408a9897d9492
BLAKE2b-256 b3cbffe6032b7feab41b4686d8bfe64addea3dad851526ea22aff6c93ba6f90e

See more details on using hashes here.

Provenance

The following attestation bundles were made for mdslides_typst-0.1.2-py3-none-any.whl:

Publisher: python-publish.yml on cavenditti/mdslides-typst

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page