Skip to content

docs: add Typst installation instructions - #4986

Open
aryansk wants to merge 1 commit into
ManimCommunity:mainfrom
aryansk:ops074/manim-4938
Open

docs: add Typst installation instructions#4986
aryansk wants to merge 1 commit into
ManimCommunity:mainfrom
aryansk:ops074/manim-4938

Conversation

@aryansk

@aryansk aryansk commented Sep 2, 2026

Copy link
Copy Markdown

Summary of Changes

  • Document how to install Manim with the optional Typst dependency using uv or pip.
  • Explain that the optional Python package includes the Typst compiler and link to the usage guide.

Motivation and Explanation

The installation guide did not explain how to enable Typst support for a local Manim project. This adds the missing setup step and keeps the installation instructions aligned with the existing Typst examples.

Closes #4938

Checklist

  • I have read the Contributing Guidelines
  • I have written a descriptive PR title
  • My new documentation builds, looks correctly formatted, and adds no additional build warnings

@behackl behackl left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution! Looking good overall, I just left two minor comments. Let me know what you think -- am then happy to get this merged.

```
:::

### Step 2 (optional): Installing Typst support

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would mean the sections are labeled Step 1, Step 2 (optional), Step 2 (optional), Step 3, ...

Would it not make more sense to make this an optional Step 3 and bump the steps afterwards?

pip install "manim[typst]"
```

See the :ref:`Typst text guide <rendering-with-typst>` for examples.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps a little more verbose?

Suggested change
See the :ref:`Typst text guide <rendering-with-typst>` for examples.
See the :ref:`Typst section in the text guide <rendering-with-typst>` for examples.

@behackl behackl added the documentation Improvements or additions to documentation label Sep 3, 2026
@behackl
behackl marked this pull request as ready for review September 3, 2026 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

no instructions for typst installation

2 participants