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.4.tar.gz (127.6 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.4-py3-none-any.whl (122.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: quickslides-0.1.4.tar.gz
  • Upload date:
  • Size: 127.6 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.4.tar.gz
Algorithm Hash digest
SHA256 349ef1094fb9f3614b94315735b4a5f53fbe550f70925b7e151d85ada863e6c7
MD5 9437add87a0761738d5c8070198aa6bf
BLAKE2b-256 2b6896fc68e6e21762e4f496c461a7ad1a5525f05c06e40482c40ab1134189d6

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: quickslides-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 122.9 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 2d3aeac6d0bc7d02a0ea33e98b0abe9d423f3e2a466dc0a02493985367045b64
MD5 290d00ee90e00cac03c52a7209932f23
BLAKE2b-256 352e9ae636c3e37eb1a0bc5be2b78293e4686b61d60518eb986e0917b2e27a10

See more details on using hashes here.

Provenance

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