Skip to main content

Obsidian to Typst

This utility attempts to make it easy to convert markdown documents written using obsidian into PDFs.

Requirements

  • typst (>=0.14.0, needed for embedding PDFs as images)
  • mermaid
  • mutool

Getting Started

This project uses uv to manage its python environment. Follow the installation instructions for uv.

Install typst using a package manager or cargo install

Run uv sync to install and set up the python virtual environment.

Than, run uv run obsidian_to_typst .\examples\feature_guide\Widget.md to convert the example document to a PDF. The PDF will be placed in .\examples\feature_guide\output\Widget.pdf.

watchexec --clear=clear --exts py "uv run ruff format && uv run ruff check --fix && uv run pytest && uv run obsidian-to-typst ./examples/feature_guide/Widget.md"

Metadata

Release files for obsidian-to-typst 0.2.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for obsidian-to-typst 0.2.5
File Size Uploaded
obsidian_to_typst-0.2.5.tar.gz 89.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for obsidian-to-typst 0.2.5
File Interpreter ABI Platform
obsidian_to_typst-0.2.5-py3-none-any.whl Python 3 none any Details

Total release size: 99.4 kB

Release files / obsidian_to_typst-0.2.5.tar.gz

Download URL obsidian_to_typst-0.2.5.tar.gz
Size 89.8 kB
Tags Source
SHA-256 checksum
How to use checksums
0e0be9d215c401dcfd6b594cedcd5a5a42169dd1de8d0de5399e4e5cfe9e2055
BLAKE2b-256 checksum
How to use checksums
9b27716d5ebce97c558735329d7ea13ef2be9cfcc9ba8d1491c44042279e574e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Linux Mint","version":"22.2","id":"zara","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / obsidian_to_typst-0.2.5-py3-none-any.whl

Download URL obsidian_to_typst-0.2.5-py3-none-any.whl
Size 9.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
bd505a297e7b75fa326f1a978b86641b97032431fbbccc15f7d79f77dab369a8
BLAKE2b-256 checksum
How to use checksums
3fc2e8cb9a322d05c6da25dd639dc180583d56a870c35aeddaf07e87713a8c9d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Linux Mint","version":"22.2","id":"zara","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release history Release notifications | RSS feed

0.2.6

2 release files

This release

0.2.5 This release

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page