Skip to main content

Convert Markdown to PDF slides using Typst and typslides

Project description

quickslides

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

Usage

Command Line

# Basic usage
quickslides your_presentation.md

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

As a Library

from quickslides 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

quickslides-0.1.7.tar.gz (127.8 kB view details)

Uploaded Source

Built Distribution

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

quickslides-0.1.7-py3-none-any.whl (123.1 kB view details)

Uploaded Python 3

File details

Details for the file quickslides-0.1.7.tar.gz.

File metadata

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

File hashes

Hashes for quickslides-0.1.7.tar.gz
Algorithm Hash digest
SHA256 5943c96c60a6cfd764e2af894c528514e26d0cfe784383808c51bf219314ef77
MD5 058c3861a1ed317fa281fdc82497943e
BLAKE2b-256 ef1e0f9da2873562c69e658d4e067c466349adbb91586788a46770ab5d9cb289

See more details on using hashes here.

Provenance

The following attestation bundles were made for quickslides-0.1.7.tar.gz:

Publisher: python-publish.yml on cavenditti/quickslides

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

File details

Details for the file quickslides-0.1.7-py3-none-any.whl.

File metadata

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

File hashes

Hashes for quickslides-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 1b983778e08b1bfdf28158b4d401fc80673edf839159eca31563c26cb7f16f21
MD5 09be186a2593cd1dee2f5254b8471c13
BLAKE2b-256 57b2da2e8e01afe27f28ca0bf273a073abc12705bc05abfa8fd8b3a7efddd37b

See more details on using hashes here.

Provenance

The following attestation bundles were made for quickslides-0.1.7-py3-none-any.whl:

Publisher: python-publish.yml on cavenditti/quickslides

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