The former contains the logic to animate your slides, while the
second defines a number of steps to render your slides into a
portable presentation format, and publish it on the internet.
It uses GitHub actions
and
GitHub pages
which are free for public repositories.
Creating a new repository
First, you need to create a new repository by clicking on the
Use this template
button.
> NOTE: if you want to have a private repository, you will probably need
a GitHub Pro account.
### Customizing your presentation
By default, the generated presentation is obtained from the
[`slides.py`](./slides.py) file, uses Manim Community Edition,
and renders the following scenes: `Introduction`, `WithTeX`,
ans `Outro`.
Of course, you can update or create Python files to
generate your animations. If you require a specific
version of `manim-slides`, `manim` or `manimlib`,
please edit [`requirements.txt`](./requirements.txt).
Additionally, you can edit the following environ variables
to reflect your changes:
https://github.com/jeertmans/manim-slides-starter/blob/d9799748b124c71626175de8d156c8010bf6f68d/.github/workflows/deploy_pages.yml#L19-L23
> **WARNING**: `manimgl` is currently not supported, as rendering animations
> inside GitHub workflows seems complex...
Last, if you want to change the scenes rendering and the HTML
conversion, feel free to edit the last two lines:
https://github.com/jeertmans/manim-slides-starter/blob/d9799748b124c71626175de8d156c8010bf6f68d/.github/workflows/deploy_pages.yml#L93-L96
## Where is the output?
On every commit to the `main` branch, a new deployment action should be
triggered. If that is not the case, inspect the [actions](../../actions) tab for
any error message. You can also manually trigger a deployment by clicking on
the [*Run workflow*](../../actions/workflows/deploy_pages.yml) button.
If everything goes well, the deploying site should be on your
personal GitHub pages site: `https://.github.io/`.
For example, this starter's website is:
https://jeertmans.github.io/manim-slides-starter.
> NOTE: the first time the deployment action is used,
> the `gh-pages` branch is created. You might need
> to go to [`Settings -> Pages`](../../settings/pages)
> and make sure that the *Source* is
> *Deploy from a branch*, and *branch* is *gh-pages*.
