mirror of
https://github.com/jeertmans/manim-slides.git
synced 2025-05-23 21:46:49 +08:00
04bca458f1
* chore(ci): checking links and spell checking * chore(ci): move markdown-link-check to GitHub ci Because pre-commit.ci does not have access to the internet... * fix(lib): revert `reverse-...` utils because of warnings * chore(ci): checking links and spell checking * chore(ci): move markdown-link-check to GitHub ci Because pre-commit.ci does not have access to the internet... * fix(docs): myst-parser xref cannot end with .html * fix(docs): oops
36 lines
827 B
Markdown
36 lines
827 B
Markdown
# Quickstart
|
|
|
|
If not already, install Manim Slides, along with either Manim or ManimGL,
|
|
see [installation](/installation).
|
|
|
|
## Creating your first slides
|
|
|
|
```{include} ../../README.md
|
|
:start-after: <!-- start usage -->
|
|
:end-before: <!-- end usage -->
|
|
```
|
|
|
|
:::{note}
|
|
Using `manim-slides render` makes sure to use the `manim`
|
|
(or `manimlib`) library that was installed in the same Python environment.
|
|
Put simply, this is a wrapper around
|
|
`manim render [ARGS]...` (or `manimgl [ARGS]...`).
|
|
:::
|
|
|
|
|
|
```{include} ../../README.md
|
|
:start-after: <!-- start more-usage -->
|
|
:end-before: <!-- end more-usage -->
|
|
```
|
|
|
|
The output slides should look this this:
|
|
|
|
```{eval-rst}
|
|
.. manim-slides:: ../../example.py:BasicExample
|
|
:hide_source:
|
|
:quality: high
|
|
```
|
|
|
|
For more advanced examples,
|
|
see the [Examples](/reference/examples) section.
|