mirror of
https://github.com/jeertmans/manim-slides.git
synced 2025-05-23 13:36:23 +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
41 lines
1.3 KiB
Markdown
41 lines
1.3 KiB
Markdown
# HTML Presentations
|
|
|
|
Manim Slides allows you to convert presentations into one HTML file, with
|
|
[RevealJS](https://revealjs.com/). This file can then be opened with any modern
|
|
web browser, allowing for a nice portability of your presentations.
|
|
|
|
As with every command with Manim Slides, converting slides' fragments into one
|
|
HTML file (and its assets) can be done in one command:
|
|
|
|
```bash
|
|
manim-slides convert [SCENES]... DEST
|
|
```
|
|
|
|
where `DEST` is the `.html` destination file.
|
|
|
|
## Configuring the Template
|
|
|
|
Many configuration options are available through the `-c<option>=<value>` syntax.
|
|
Most, if not all, RevealJS options should be available by default. If that is
|
|
not the case, please
|
|
[fill an issue](https://github.com/jeertmans/manim-slides/issues/new/choose)
|
|
on GitHub.
|
|
|
|
You can print the list of available options with:
|
|
|
|
```bash
|
|
manim-slides convert --show-config
|
|
```
|
|
|
|
## Using a Custom Template
|
|
|
|
The default template used for HTML conversion can be found on
|
|
[GitHub](https://github.com/jeertmans/manim-slides/blob/main/manim_slides/templates/revealjs.html)
|
|
or printed with the `--show-template` option.
|
|
If you wish to use another template, you can do so with the
|
|
`--use-template FILE` option.
|
|
|
|
## More about HTML Slides
|
|
|
|
You can read more about HTML slides in the [sharing](/reference/sharing) section.
|