Metadata-Version: 2.4
Name: obsidian-to-typst
Version: 0.2.5
Summary: Convert Obsidian vault documents to typst and pdfs
Project-URL: repository, https://github.com/drbartling/obsidian-to-typst
Author-email: Ryan Bartling <ryan.bartling@gmail.com>
License-Expression: MIT
Requires-Python: <3.15,>=3.11
Requires-Dist: click>=8.2.1
Requires-Dist: colorama>=0.4.6
Requires-Dist: colored-traceback>=0.4.2
Requires-Dist: coloredlogs>=15.0.1
Requires-Dist: pydantic>=2.13.4
Requires-Dist: pypdf>=6.14.2
Description-Content-Type: text/markdown

# 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](https://docs.astral.sh/uv/) to manage its python environment. Follow the [installation instructions](https://docs.astral.sh/uv/getting-started/installation/) 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`.

```powershell
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"
```
