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.6.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.6-py3-none-any.whl (123.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: quickslides-0.1.6.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.6.tar.gz
Algorithm Hash digest
SHA256 c9e9f589808b2e1daf3ff4244669f56cd97af26eeb6e5559873ef326ca624cc0
MD5 9dfd03e31ecb92f4999ce1a4df4041fc
BLAKE2b-256 5532aa996fb70a6868930fee46259a847ec78f9c8538ea592fa3151b1872dffa

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: quickslides-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 123.2 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 45ac47f0b12cf189ab743494e681f7f6213849c8b884430790553a6e0c3c5fc5
MD5 4799384b6fb37ea586b043a2c7c516c7
BLAKE2b-256 caed30a53ea89fb937b9833c3866ffd75f320cb7ccf1fbc69c18bbc9ad43d1f7

See more details on using hashes here.

Provenance

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