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.3.tar.gz (126.9 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.3-py3-none-any.whl (122.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: quickslides-0.1.3.tar.gz
  • Upload date:
  • Size: 126.9 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.3.tar.gz
Algorithm Hash digest
SHA256 9c9f7e3ebcc64079c9a5866144a816d81cb913adc3be0223ee89f4b1838b6f98
MD5 531e614a47c37898861415be1b13f4e1
BLAKE2b-256 d86258fbc1662864c29f79ac09d3a1d1850f93e645f6a98beab5a4a5e6b1f20e

See more details on using hashes here.

Provenance

The following attestation bundles were made for quickslides-0.1.3.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.3-py3-none-any.whl.

File metadata

  • Download URL: quickslides-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 122.3 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3e6c98fe3f403c5c49efce6da954c31e15f318968ae8f5d3df540bd541f40a02
MD5 7e85f49dcfe18cd5eac2afd006d08f07
BLAKE2b-256 2803d4f18fb3b216f376f288b975ffc0fc03f97a5ea9147ae59f331ff9788726

See more details on using hashes here.

Provenance

The following attestation bundles were made for quickslides-0.1.3-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