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
- Python 3.12+
- typst
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file quickslides-0.1.5.tar.gz.
File metadata
- Download URL: quickslides-0.1.5.tar.gz
- Upload date:
- Size: 127.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e9df83d1f2df7afd024b4a0997b328d0e4b89c3f3076a6871b34f9dca9297e07
|
|
| MD5 |
d980090289359c7921b5caee8d656cf8
|
|
| BLAKE2b-256 |
1bc7dd848335e335fab0f67b174018f2ae267573fc8c9a23bdfe9eeea27e6a9b
|
Provenance
The following attestation bundles were made for quickslides-0.1.5.tar.gz:
Publisher:
python-publish.yml on cavenditti/quickslides
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
quickslides-0.1.5.tar.gz -
Subject digest:
e9df83d1f2df7afd024b4a0997b328d0e4b89c3f3076a6871b34f9dca9297e07 - Sigstore transparency entry: 193313104
- Sigstore integration time:
-
Permalink:
cavenditti/quickslides@4e208c6af021f5e4f76c660f857673f5a5896ece -
Branch / Tag:
refs/tags/v0.1.5 - Owner: https://github.com/cavenditti
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@4e208c6af021f5e4f76c660f857673f5a5896ece -
Trigger Event:
release
-
Statement type:
File details
Details for the file quickslides-0.1.5-py3-none-any.whl.
File metadata
- Download URL: quickslides-0.1.5-py3-none-any.whl
- Upload date:
- Size: 123.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
267dce13c2f5f32b2213e28bf6b30e5e220750fab3690525d7797de3172c39a7
|
|
| MD5 |
e0b6dff34fb4b15b94a6f7c10c008844
|
|
| BLAKE2b-256 |
d1480156d6058e7789a3b92536dc3e15732096f6cd264bb2171649a1f643592d
|
Provenance
The following attestation bundles were made for quickslides-0.1.5-py3-none-any.whl:
Publisher:
python-publish.yml on cavenditti/quickslides
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
quickslides-0.1.5-py3-none-any.whl -
Subject digest:
267dce13c2f5f32b2213e28bf6b30e5e220750fab3690525d7797de3172c39a7 - Sigstore transparency entry: 193313113
- Sigstore integration time:
-
Permalink:
cavenditti/quickslides@4e208c6af021f5e4f76c660f857673f5a5896ece -
Branch / Tag:
refs/tags/v0.1.5 - Owner: https://github.com/cavenditti
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@4e208c6af021f5e4f76c660f857673f5a5896ece -
Trigger Event:
release
-
Statement type: