Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/source/guides/using_text.rst
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,9 @@ Manim also supports rendering text and formulas with Typst via
.. important::

Typst support requires the optional ``typst`` dependency. Install it with
``pip install manim[typst]``.
``uv add "manim[typst]"`` or ``pip install "manim[typst]"``. The optional
dependency includes the Typst compiler; no separate system installation is
required.

Typst mobjects compile Typst markup directly to SVG and import the result as
vector graphics. This works both for general markup and for mathematical
Expand Down
21 changes: 21 additions & 0 deletions docs/source/installation/uv.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,27 @@ setspace standalone tipa wasy wasysym xcolor xetex xkeyval
```
:::

### 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?


Manim can render text and mathematical expressions with [Typst](https://typst.app/).
The Typst compiler is provided by the optional `typst` Python dependency, so no
separate system-level Typst installation is required.

If you plan to use the `Typst` or `MathTypst` mobjects,
include the optional dependency when adding Manim to your project:

```bash
uv add "manim[typst]"
```

If you installed Manim with `pip` instead, use:

```bash
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.


### Step 3: Installing Manim

These steps again differ slightly between different operating systems. Make
Expand Down