chore(version): bump to 4.8.2

chore(docs): improving the docs a bit more (#116 )
* chore(docs): improving the docs a bit more This adds some useful extensions, links, and add. information. * fix(deps): update lockfiles no-cache
2025-05-18 11:05:54 +08:00 · 2023-01-31 10:41:55 +01:00 · 2023-01-31 10:29:21 +01:00 · 2023-01-31 10:07:59 +01:00 · 2023-01-30 22:45:43 +01:00 · 2023-01-30 22:25:40 +01:00
36 changed files with 2742 additions and 1159 deletions
--- a/.flake8
+++ b/.flake8
@ -1,5 +0,0 @@
-[flake8]
-min_python_version = 3.7
-extend-ignore =
-    # E501: line too long
-    E501,
--- a/.github/ISSUE_TEMPLATE/bug.yml
+++ b/.github/ISSUE_TEMPLATE/bug.yml
@ -1,40 +1,40 @@
 name: Bug
 description: Report an issue to help improve the project.
-labels: "bug"
+labels: bug
 title: '[BUG] <description>'
 body:
-  - type: textarea
-    id: description
-    attributes:
-      label: Description
-      description: A brief description of the question or issue, also include what you tried and what didn't work
-    validations:
-      required: true
-  - type: textarea
-    id: version
-    attributes:
-      label: Version
-      description: Which version of Manim Slides are you using? You can use `manim-slides --version` to get that information.
-    validations:
-      required: true
-  - type: textarea
-    id: platform
-    attributes:
-      label: Platform
-      description: What is your platform. Linux, macOS, or Windows?
-    validations:
-      required: true
-  - type: textarea
-    id: screenshots
-    attributes:
-      label: Screenshots
-      description: Please add screenshots if applicable
-    validations:
-      required: false
-  - type: textarea
-    id: extrainfo
-    attributes:
-      label: Additional information
-      description: Is there anything else we should know about this bug?
-    validations:
-      required: false
+- type: textarea
+  id: description
+  attributes:
+    label: Description
+    description: A brief description of the question or issue, also include what you tried and what didn't work
+  validations:
+    required: true
+- type: textarea
+  id: version
+  attributes:
+    label: Version
+    description: Which version of Manim Slides are you using? You can use `manim-slides --version` to get that information.
+  validations:
+    required: true
+- type: textarea
+  id: platform
+  attributes:
+    label: Platform
+    description: What is your platform. Linux, macOS, or Windows?
+  validations:
+    required: true
+- type: textarea
+  id: screenshots
+  attributes:
+    label: Screenshots
+    description: Please add screenshots if applicable
+  validations:
+    required: false
+- type: textarea
+  id: extrainfo
+  attributes:
+    label: Additional information
+    description: Is there anything else we should know about this bug?
+  validations:
+    required: false
--- a/.github/ISSUE_TEMPLATE/documentation.yml
+++ b/.github/ISSUE_TEMPLATE/documentation.yml
@ -1,59 +1,59 @@
 name: Documentation
 description: Ask / Report an issue related to the documentation.
-title: "DOC: <description>"
-labels: ['bug', 'docs']
+title: 'DOC: <description>'
+labels: [bug, docs]

 body:
-  - type: markdown
-    attributes:
-      value: >
-        **Thank you for wanting to report a problem with manim-slides docs!**
+- type: markdown
+  attributes:
+    value: >
+      **Thank you for wanting to report a problem with manim-slides docs!**


-        If the problem seems straightforward, feel free to submit a PR instead!
+      If the problem seems straightforward, feel free to submit a PR instead!


-        ⚠
-        Verify first that your issue is not already reported on GitHub [Issues].
+      ⚠
+      Verify first that your issue is not already reported on GitHub [Issues].


-        [Issues]:
-        https://github.com/jeertmans/manim-slides/issues
+      [Issues]:
+      https://github.com/jeertmans/manim-slides/issues

-  - type: textarea
-    attributes:
-      label: Describe the Issue
-      description: A clear and concise description of the issue you encountered.
-    validations:
-      required: true
+- type: textarea
+  attributes:
+    label: Describe the Issue
+    description: A clear and concise description of the issue you encountered.
+  validations:
+    required: true

-  - type: input
-    attributes:
-      label: Affected Page
-      description: Add a link to page with the problem.
-    validations:
-      required: true
+- type: input
+  attributes:
+    label: Affected Page
+    description: Add a link to page with the problem.
+  validations:
+    required: true

-  - type: dropdown
-    attributes:
-      label: Issue Type
-      description: >
-        Please select the option in the drop-down.
+- type: dropdown
+  attributes:
+    label: Issue Type
+    description: >
+      Please select the option in the drop-down.

-        <details>
-          <summary>
-            <em>Issue?</em>
-          </summary>
-        </details>
-      options:
-        - Documentation Enhancement
-        - Documentation Report
-    validations:
-      required: true
+      <details>
+        <summary>
+          <em>Issue?</em>
+        </summary>
+      </details>
+    options:
+    - Documentation Enhancement
+    - Documentation Report
+  validations:
+    required: true

-  - type: textarea
-    attributes:
-      label: Recommended fix or suggestions
-      description: A clear and concise description of how you want to update it.
-    validations:
-      required: false
+- type: textarea
+  attributes:
+    label: Recommended fix or suggestions
+    description: A clear and concise description of how you want to update it.
+  validations:
+    required: false
--- a/.github/ISSUE_TEMPLATE/feature_request.yml
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@ -1,26 +1,26 @@
 name: Feature Request
 description: Have a new idea/feature? Please suggest!
-labels: "enhancement"
+labels: enhancement
 title: '[FEATURE] <description>'
 body:
-  - type: textarea
-    id: description
-    attributes:
-      label: Description
-      description: A brief description of the enhancement you propose, also include what you tried and what worked.
-    validations:
-      required: true
-  - type: textarea
-    id: screenshots
-    attributes:
-      label: Screenshots
-      description: Please add screenshots if applicable
-    validations:
-      required: false
-  - type: textarea
-    id: extrainfo
-    attributes:
-      label: Additional information
-      description: Is there anything else we should know about this idea?
-    validations:
-      required: false
+- type: textarea
+  id: description
+  attributes:
+    label: Description
+    description: A brief description of the enhancement you propose, also include what you tried and what worked.
+  validations:
+    required: true
+- type: textarea
+  id: screenshots
+  attributes:
+    label: Screenshots
+    description: Please add screenshots if applicable
+  validations:
+    required: false
+- type: textarea
+  id: extrainfo
+  attributes:
+    label: Additional information
+    description: Is there anything else we should know about this idea?
+  validations:
+    required: false
--- a/.github/ISSUE_TEMPLATE/support.yml
+++ b/.github/ISSUE_TEMPLATE/support.yml
@ -1,14 +1,14 @@
 name: Question/Help/Support
 description: Ask us about Manim Slides
-title: "Support: Ask us anything"
-labels: ['help', 'question']
+title: 'Support: Ask us anything'
+labels: [help, question]

 body:
-  - type: textarea
-    attributes:
-      label: "Please explain the issue you're experiencing (with as much detail as possible):"
-      description: >
-        Please make sure to leave a reference to the document/code you're
-        referring to.
-    validations:
-      required: true
+- type: textarea
+  attributes:
+    label: "Please explain the issue you're experiencing (with as much detail as possible):"
+    description: >
+      Please make sure to leave a reference to the document/code you're
+      referring to.
+  validations:
+    required: true
--- a/.github/workflows/codeql-analysis.yml
+++ b/.github/workflows/codeql-analysis.yml
@ -9,16 +9,16 @@
 # the `language` matrix defined below to confirm you have the correct set of
 # supported CodeQL languages.
 #
-name: "CodeQL"
+name: CodeQL

 on:
  push:
-    branches: [ "main" ]
+    branches: [main]
  pull_request:
    # The branches below must be a subset of the branches above
-    branches: [ "main" ]
+    branches: [main]
  schedule:
-    - cron: '45 3 * * 2'
+  - cron: 45 3 * * 2

 jobs:
  analyze:
@ -32,7 +32,7 @@ jobs:
    strategy:
      fail-fast: false
      matrix:
-        language: [ 'python' ]
+        language: [python]
        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support

--- a/.github/workflows/languagetool.yml
+++ b/.github/workflows/languagetool.yml
@ -8,8 +8,8 @@ jobs:
  languagetool_check:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/checkout@v1
-      - uses: reviewdog/action-languagetool@v1
-        with:
-          reporter: github-pr-review
-          level: warning
+    - uses: actions/checkout@v1
+    - uses: reviewdog/action-languagetool@v1
+      with:
+        reporter: github-pr-review
+        level: warning
--- a/.github/workflows/pages.yml
+++ b/.github/workflows/pages.yml
@ -4,7 +4,9 @@ name: Deploy static content to Pages
 on:
  # Runs on pushes targeting the default branch
  push:
-    branches: ["main"]
+    branches: [main]
+
+  pull_request:

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:
@ -17,7 +19,7 @@ permissions:

 # Allow one concurrent deployment
 concurrency:
-  group: "pages"
+  group: pages
  cancel-in-progress: true

 jobs:
@ -28,31 +30,50 @@ jobs:
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Install Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.10'
-      - name: Setup Pages
-        uses: actions/configure-pages@v2
-      - name: Install Linux Dependencies
-        run: sudo apt install libcairo2-dev libpango1.0-dev ffmpeg freeglut3-dev
-      - name: Install Python dependencies
-        run: pip install manim sphinx sphinx_click furo
-      - name: Install local Python package
-        run: pip install -e .
-      - name: Build animation and convert it into HTML slides
-        run: |
-          manim example.py ConvertExample
-          manim-slides convert ConvertExample docs/source/_static/slides.html -cembedded=true -ccontrols=true
-      - name: Build docs
-        run: cd docs && make html
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v1
-        with:
-          # Upload docs/build/html dir
-          path: 'docs/build/html/'
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v1
+    - name: Checkout
+      uses: actions/checkout@v3
+    - name: Install Poetry
+      run: pipx install poetry
+    - name: Install Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.9'
+        cache: poetry
+    - name: Setup Pages
+      uses: actions/configure-pages@v2
+    - name: Install Linux Dependencies
+      run: sudo apt install libcairo2-dev libpango1.0-dev ffmpeg freeglut3-dev
+    - name: Install Python dependencies
+      run: pip install manim sphinx sphinx_click furo
+    - name: Install local Python package
+      run: poetry install --with docs
+    - name: Restore cached media
+      id: cache-media-restore
+      uses: actions/cache/restore@v3
+      with:
+        path: media
+        key: ${{ runner.os }}-media
+    - name: Build animation and convert it into HTML slides
+      run: |
+        poetry run manim example.py ConvertExample BasicExample ThreeDExample
+        poetry run manim-slides convert ConvertExample docs/source/_static/slides.html -ccontrols=true
+        poetry run manim-slides convert BasicExample docs/source/_static/basic_example.html -ccontrols=true
+        poetry run manim-slides convert ThreeDExample docs/source/_static/three_d_example.html -ccontrols=true
+    - name: Save media to cache
+      id: cache-media-save
+      uses: actions/cache/save@v3
+      with:
+        path: media
+        key: ${{ steps.cache-media-restore.outputs.cache-primary-key }}
+    - name: Build docs
+      run: cd docs && poetry run make html
+    - name: Upload artifact
+      if: github.event_name != 'pull_request'
+      uses: actions/upload-pages-artifact@v1
+      with:
+        # Upload docs/build/html dir
+        path: docs/build/html/
+    - name: Deploy to GitHub Pages
+      id: deployment
+      if: github.event_name != 'pull_request'
+      uses: actions/deploy-pages@v1
--- a/.github/workflows/python-publish.yml
+++ b/.github/workflows/python-publish.yml
@ -16,33 +16,33 @@ jobs:
        os: [ubuntu-latest]

    steps:
-      - uses: actions/checkout@v2
+    - uses: actions/checkout@v2

-      - uses: actions/setup-python@v2
+    - uses: actions/setup-python@v2

-      - name: Install build package
-        run: python -m pip install -U build
+    - name: Install build package
+      run: python -m pip install -U build

-      - name: Build wheels
-        run: python -m build --sdist
+    - name: Build wheels
+      run: python -m build --sdist

-      - uses: actions/upload-artifact@v2
-        with:
-          name: dist
-          path: dist/*.tar.*
+    - uses: actions/upload-artifact@v2
+      with:
+        name: dist
+        path: dist/*.tar.*

  release:
    name: Release
    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
    runs-on: ubuntu-latest
-    needs: [ build_wheels ]
+    needs: [build_wheels]
    steps:
-      - uses: actions/download-artifact@v2
-        with:
-          name: dist
-          path: dist/
-      - name: Upload to PyPI
-        uses: pypa/gh-action-pypi-publish@master
-        with:
-          user: __token__
-          password: ${{ secrets.PYPI_API_TOKEN }}
+    - uses: actions/download-artifact@v2
+      with:
+        name: dist
+        path: dist/
+    - name: Upload to PyPI
+      uses: pypa/gh-action-pypi-publish@master
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}
--- a/.github/workflows/test_examples.yml
+++ b/.github/workflows/test_examples.yml
@ -1,8 +1,8 @@
 on:
  pull_request:
    paths:
-      - '**.py'
-      - '.github/workflows/test_examples.yml'
+    - '**.py'
+    - .github/workflows/test_examples.yml
  workflow_dispatch:

 name: Test Examples
@ -11,7 +11,7 @@ env:
  QT_QPA_PLATFORM: offscreen
  MANIM_SLIDES_VERBOSITY: debug
  PYTHONFAULTHANDLER: 1
-  DISPLAY: ":99"
+  DISPLAY: :99

 jobs:
  build-examples:
@ -44,74 +44,74 @@ jobs:
          manim: manim
    runs-on: ${{ matrix.os }}
    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v3
-      - name: Install Poetry
-        run: pipx install poetry
-      - name: Install Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.pyversion }}
-          cache: 'poetry'
+    - name: Checkout repository
+      uses: actions/checkout@v3
+    - name: Install Poetry
+      run: pipx install poetry
+    - name: Install Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.pyversion }}
+        cache: poetry

      # Path related stuff
-      - name: Append to Path on MacOS
-        if: matrix.os == 'macos-latest'
-        run: |
-          echo "${HOME}/.local/bin" >> $GITHUB_PATH
-          echo "/Users/runner/Library/Python/${{ matrix.pyversion }}/bin" >> $GITHUB_PATH
-      - name: Append to Path on Ubuntu
-        if: matrix.os == 'ubuntu-latest'
-        run: echo "${HOME}/.local/bin" >> $GITHUB_PATH
-      - name: Append to Path on Windows
-        if: matrix.os == 'windows-latest'
-        run: echo "${HOME}/.local/bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
+    - name: Append to Path on MacOS
+      if: matrix.os == 'macos-latest'
+      run: |
+        echo "${HOME}/.local/bin" >> $GITHUB_PATH
+        echo "/Users/runner/Library/Python/${{ matrix.pyversion }}/bin" >> $GITHUB_PATH
+    - name: Append to Path on Ubuntu
+      if: matrix.os == 'ubuntu-latest'
+      run: echo "${HOME}/.local/bin" >> $GITHUB_PATH
+    - name: Append to Path on Windows
+      if: matrix.os == 'windows-latest'
+      run: echo "${HOME}/.local/bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append

      # OS depedencies
-      - name: Install manim dependencies on MacOs
-        if: matrix.os == 'macos-latest' && matrix.manim == 'manim'
-        run: brew install ffmpeg py3cairo
-      - name: Install manimgl dependencies on MacOS
-        if: matrix.os == 'macos-latest' && matrix.manim == 'manimgl'
-        run: brew install ffmpeg
-      - name: Install manim dependencies on Ubuntu
-        if: matrix.os == 'ubuntu-latest' && matrix.manim == 'manim'
-        run: |
-          sudo apt-get install libcairo2-dev libpango1.0-dev ffmpeg freeglut3-dev
-      - name: Install manimgl dependencies on Ubuntu
-        if: matrix.os == 'ubuntu-latest' && matrix.manim == 'manimgl'
-        run: |
-          sudo apt-get install libpango1.0-dev ffmpeg freeglut3-dev
-      - name: Install xvfb on Ubuntu
-        if: matrix.os == 'ubuntu-latest' && matrix.manim == 'manimgl'
-        run: |
-          sudo apt-get install xvfb
-          nohup Xvfb $DISPLAY &
-      - name: Install Windows dependencies
-        if: matrix.os == 'windows-latest'
-        run: choco install ffmpeg
+    - name: Install manim dependencies on MacOs
+      if: matrix.os == 'macos-latest' && matrix.manim == 'manim'
+      run: brew install ffmpeg py3cairo
+    - name: Install manimgl dependencies on MacOS
+      if: matrix.os == 'macos-latest' && matrix.manim == 'manimgl'
+      run: brew install ffmpeg
+    - name: Install manim dependencies on Ubuntu
+      if: matrix.os == 'ubuntu-latest' && matrix.manim == 'manim'
+      run: |
+        sudo apt-get install libcairo2-dev libpango1.0-dev ffmpeg freeglut3-dev
+    - name: Install manimgl dependencies on Ubuntu
+      if: matrix.os == 'ubuntu-latest' && matrix.manim == 'manimgl'
+      run: |
+        sudo apt-get install libpango1.0-dev ffmpeg freeglut3-dev
+    - name: Install xvfb on Ubuntu
+      if: matrix.os == 'ubuntu-latest' && matrix.manim == 'manimgl'
+      run: |
+        sudo apt-get install xvfb
+        nohup Xvfb $DISPLAY &
+    - name: Install Windows dependencies
+      if: matrix.os == 'windows-latest'
+      run: choco install ffmpeg

      # Install Manim Slides
-      - name: Install Manim Slides
-        run: |
-          poetry config experimental.new-installer false
-          poetry install
+    - name: Install Manim Slides
+      run: |
+        poetry config experimental.new-installer false
+        poetry install --with test

-      # Render slides
-      - name: Render slides
-        if: matrix.manim == 'manim'
-        run: poetry run manim -ql example.py Example ThreeDExample
-      - name: Render slides
-        if: matrix.manim == 'manimgl'
-        run: poetry run -v manimgl -l example.py Example ThreeDExample
+    # Render slides
+    - name: Render slides
+      if: matrix.manim == 'manim'
+      run: poetry run manim -ql example.py BasicExample ThreeDExample
+    - name: Render slides
+      if: matrix.manim == 'manimgl'
+      run: poetry run -v manimgl -l example.py BasicExample ThreeDExample

-      # Play slides
-      - name: Test slides
-        run: poetry run manim-slides Example ThreeDExample --skip-all
+    # Play slides
+    - name: Test slides
+      run: poetry run manim-slides BasicExample ThreeDExample --skip-all

-      # Test slides to html
-      - name: Test convert on Ubuntu
-        if: matrix.os == 'ubuntu-latest' && matrix.manim == 'manim'
-        run: |
-          poetry run manim -ql example.py ConvertExample
-          poetry run manim-slides convert --to=html ConvertExample index.html
+    # Test slides to html
+    - name: Test convert on Ubuntu
+      if: matrix.os == 'ubuntu-latest' && matrix.manim == 'manim'
+      run: |
+        poetry run manim -ql example.py ConvertExample
+        poetry run manim-slides convert --to=html ConvertExample index.html
--- a/.gitignore
+++ b/.gitignore
@ -23,3 +23,15 @@ docs/build/
 docs/source/_static/slides_assets/

 docs/source/_static/slides.html
+
+slides_assets/
+
+slides.html
+
+docs/source/_static/basic_example_assets/
+
+docs/source/_static/basic_example.html
+
+docs/source/_static/three_d_example.html
+
+docs/source/_static/three_d_example_assets/
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@ -1,59 +1,34 @@
 repos:
-   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
-    hooks:
-    -   id: check-yaml
-    -   id: end-of-file-fixer
-    -   id: trailing-whitespace
-   repo: https://github.com/pycqa/isort
-    rev: 5.10.1
-    hooks:
-      - id: isort
-        name: isort (python)
-        args: ["--python-version", "37", "--profile", "black"]
-   repo: https://github.com/psf/black
-    rev: 22.10.0
-    hooks:
-      - id: black
-        args: ["--target-version", "py37"]
-   repo: https://github.com/PyCQA/flake8
-    rev: 6.0.0
-    hooks:
-      - id: flake8
-        additional_dependencies:
-        - flake8-bugbear
-        - flake8-comprehensions
-        - flake8-tidy-imports
-        - flake8-typing-imports
-   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: 'v0.991'
-    hooks:
-    -   id: mypy
-        additional_dependencies: [types-requests, types-setuptools]
-        args:
-        - --install-types
-        - --non-interactive
-        - --ignore-missing-imports
-        # Disallow dynamic typing
-        - --disallow-any-generics
-        - --disallow-subclassing-any
-
-        # Disallow untyped definitions and calls
-        - --disallow-untyped-defs
-        - --disallow-incomplete-defs
-        - --check-untyped-defs
-
-        # None and optional handling
-        - --no-implicit-optional
-
-        # Configuring warnings
-        - --warn-unused-ignores
-        - --warn-no-return
-        - --no-warn-return-any
-        - --warn-redundant-casts
-
-        # Strict equality
-        - --strict-equality
-
-        # Config file
-        - --warn-unused-configs
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.4.0
+  hooks:
+  - id: check-yaml
+  - id: check-toml
+  - id: end-of-file-fixer
+  - id: trailing-whitespace
+- repo: https://github.com/pycqa/isort
+  rev: 5.12.0
+  hooks:
+  - id: isort
+    name: isort (python)
+- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
+  rev: v2.6.0
+  hooks:
+  - id: pretty-format-yaml
+    args: [--autofix]
+  - id: pretty-format-toml
+    exclude: poetry.lock
+    args: [--autofix]
+- repo: https://github.com/psf/black
+  rev: 22.12.0
+  hooks:
+  - id: black
+- repo: https://github.com/charliermarsh/ruff-pre-commit
+  rev: v0.0.237
+  hooks:
+  - id: ruff
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v0.991
+  hooks:
+  - id: mypy
+    additional_dependencies: [types-requests, types-setuptools]
--- a/README.md
+++ b/README.md
@ -16,24 +16,31 @@ Tool for live presentations using either [Manim (community edition)](https://www
 - [Usage](#usage)
  * [Basic Example](#basic-example)
  * [Key Bindings](#key-bindings)
+  * [Interactive Tutorial](#interactive-tutorial)
  * [Other Examples](#other-examples)
- [Features and Comparison with Original manim-presentation](#features-and-comparison-with-original-manim-presentation)
+- [Comparison with Similar Tools](#comparison-with-similar-tools)
 - [F.A.Q](#faq)
  * [How to increase quality on Windows](#how-to-increase-quality-on-windows)
 - [Contributing](#contributing)

 ## Installation

+<!-- start install -->
+
 While installing Manim Slides and its dependencies on your global Python is fine, I recommend using a virtual environment (e.g., [venv](https://docs.python.org/3/tutorial/venv.html)) for a local installation.

 ### Dependencies

+<!-- start deps -->
+
 Manim Slides requires either Manim or ManimGL to be installed. Having both packages installed is fine too.

 If none of those packages are installed, please refer to their specific installation guidelines:
 - [Manim](https://docs.manim.community/en/stable/installation.html)
 - [ManimGL](https://3b1b.github.io/manim/getting_started/installation.html)

+<!-- end deps -->
+
 ### Pip Install

 The recommended way to install the latest release is to use pip:
@ -44,26 +51,22 @@ pip install manim-slides

 ### Install From Repository

-An alternative way to install Manim Slides is to clone the git repository, and install from there:
+An alternative way to install Manim Slides is to clone the git repository, and install from there: read the [contributing guide](https://eertmans.be/manim-slides/contributing/workflow.html) to know how.

-```bash
-git clone https://github.com/jeertmans/manim-slides
-pip install -e .
-```
-
-> *Note:* the `-e` flag allows you to edit the files, and observe the changes directly when using Manim Slides
+<!-- end install -->

 ## Usage

+<!-- start usage -->
+
 Using Manim Slides is a two-step process:
 1. Render animations using `Slide` (resp. `ThreeDSlide`) as a base class instead of `Scene` (resp. `ThreeDScene`), and add calls to `self.pause()` everytime you want to create a new slide.
 2. Run `manim-slides` on rendered animations and display them like a *Power Point* presentation.

-The command-line documentation is available [online](https://eertmans.be/manim-slides/).
+The documentation is available [online](https://eertmans.be/manim-slides/).

 ### Basic Example

-
 Wrap a series of animations between `self.start_loop()` and `self.stop_loop()` when you want to loop them (until input to continue):

 ```python
@ -73,7 +76,7 @@ from manim import *
 # or: from manimlib import *
 from manim_slides import Slide

-class Example(Slide):
+class BasicExample(Slide):
    def construct(self):
        circle = Circle(radius=3, color=BLUE)
        dot = Dot()
@ -87,18 +90,14 @@ class Example(Slide):

        self.play(dot.animate.move_to(ORIGIN))
        self.pause()  # Waits user to press continue to go to the next slide
-
-        self.wait()
 ```

-You **must** end your `Slide` with a `self.play(...)` or a `self.wait(...)`.
-
 First, render the animation files:

 ```bash
-manim example.py
+manim example.py BasicExample
 # or
-manimgl example.py
+manimgl example.py BasicExample
 ```

 To start the presentation using `Scene1`, `Scene2` and so on simply run:
@ -110,9 +109,11 @@ manim-slides [OPTIONS] Scene1 Scene2...
 Or in this example:

 ```bash
-manim-slides Example
+manim-slides BasicExample
 ```

+<!-- end usage -->
+
 ##  Key Bindings

 The default key bindings to control the presentation are:
@ -134,6 +135,12 @@ manim-slides init

 > **_NOTE:_**  `manim-slides` uses key codes, which are platform dependent. Using the configuration wizard is therefore highly recommended.

+## Interactive Tutorial
+
+Click on the image to watch a slides presentation that explains you how to use Manim Slides.
+
+[![Manim Slides Docs](https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/docs.png)](https://eertmans.be/manim-slides/)
+
 ## Other Examples

 Other examples are available in the [`example.py`](https://github.com/jeertmans/manim-slides/blob/main/example.py) file, if you downloaded the git repository.
@ -143,27 +150,21 @@ Below is a small recording of me playing with the slides back and forth.
 ![](https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/example.gif)


-## Features and Comparison with original manim-presentation
+## Comparison with Similar Tools

-Below is a non-exhaustive list of features:
+There exists are variety of tools that allows to create slides presentations containing Manim animations.

-| Feature | `manim-slides` | `manim-presentation` |
-|:--------|:--------------:|:--------------------:|
-| Support for Manim | :heavy_check_mark: | :heavy_check_mark: |
-| Support for ManimGL | :heavy_check_mark: | :heavy_multiplication_x: |
-| Configurable key bindings | :heavy_check_mark: | :heavy_check_mark: |
-| Configurable paths | :heavy_check_mark: | :heavy_multiplication_x: |
-| Play / Pause slides | :heavy_check_mark: | :heavy_check_mark: |
-| Next / Previous slide | :heavy_check_mark: | :heavy_check_mark: |
-| Replay slide | :heavy_check_mark: | :heavy_check_mark: |
-| Reverse slide | :heavy_check_mark: | :heavy_multiplication_x: |
-| Multiple key per actions | :heavy_check_mark: | :heavy_multiplication_x: |
-| One command line tool | :heavy_check_mark: | :heavy_multiplication_x: |
-| Robust config file parsing | :heavy_check_mark: | :heavy_multiplication_x: |
-| Support for 3D Scenes | :heavy_check_mark: | :heavy_multiplication_x: |
-| Documented code | :heavy_check_mark: | :heavy_multiplication_x: |
-| Tested on Unix, macOS, and Windows | :heavy_check_mark: | :heavy_multiplication_x: |
-| Hide mouse cursor | :heavy_check_mark: | :heavy_multiplication_x: |
+Below is a comparison of the most used ones with Manim Slides:
+
+| Project name | Manim Slides | Manim Presentation | Manim Editor | Jupyter Notebooks |
+|:------------:|:------------:|:------------------:|:------------:|:-----------------:|
+| Link | [![GitHub Repo stars](https://img.shields.io/github/stars/jeertmans/manim-slides?style=social)](https://github.com/jeertmans/manim-slides) | [![GitHub Repo stars](https://img.shields.io/github/stars/galatolofederico/manim-presentation?style=social)](https://github.com/galatolofederico/manim-presentation) | [![GitHub Repo stars](https://img.shields.io/github/stars/ManimCommunity/manim_editor?style=social)](https://github.com/ManimCommunity/manim_editor) | [![GitHub Repo stars](https://img.shields.io/github/stars/jupyter/notebook?style=social)](https://github.com/jupyter/notebook) |
+| Activity | [![GitHub Repo stars](https://img.shields.io/github/last-commit/jeertmans/manim-slides?style=social)](https://github.com/jeertmans/manim-slides) | [![GitHub Repo stars](https://img.shields.io/github/last-commit/galatolofederico/manim-presentation?style=social)](https://github.com/galatolofederico/manim-presentation) | [![GitHub Repo stars](https://img.shields.io/github/last-commit/ManimCommunity/manim_editor?style=social)](https://github.com/ManimCommunity/manim_editor) | [![GitHub Repo stars](https://img.shields.io/github/last-commit/jupyter/notebook?style=social)](https://github.com/jupyter/notebook) |
+| Usage | Command-line | Command-line | Web Browser | Notebook |
+| Note | Requires minimal modif. in scenes files | Requires minimal modif. in scenes files |  Requires the usage of sections, and configuration through graphical interface | Relies on `nbconvert` to create slides from a Notebook |
+| Support for ManimGL | Yes | No | No | No |
+| Web Browser presentations | Yes | No | Yes | No |
+| Offline presentations | Yes, with Qt | Yes, with OpenCV | No | No

 ## F.A.Q

@ -178,7 +179,7 @@ in *Settings*->*Display*.

 ## Contributing

-Contributions are more than welcome!
+Contributions are more than welcome! Please read through [our contributing section](https://eertmans.be/manim-slides/contributing/index.html).

 [pypi-version-badge]: https://img.shields.io/pypi/v/manim-slides?label=manim-slides
 [pypi-version-url]: https://pypi.org/project/manim-slides/
--- a/docs/source/changelog.md
+++ b/docs/source/changelog.md
@ -0,0 +1,3 @@
+# Changelog
+
+Changes between releases are listed in Manim Slides' [Github releases](https://github.com/jeertmans/manim-slides/releases). You can read the [latest release here](https://github.com/jeertmans/manim-slides/releases).
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@ -8,13 +8,21 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

 project = "Manim Slides"
-copyright = "2022, Jérome Eertmans"
+copyright = "2023, Jérome Eertmans"
 author = "Jérome Eertmans"

 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

-extensions = ["sphinx.ext.autodoc", "sphinx_click"]
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
+    "sphinxext.opengraph",
+    "sphinx_click",
+    "myst_parser",
+    "sphinx_copybutton",
+]

 templates_path = ["_templates"]
 exclude_patterns = []
@ -25,3 +33,29 @@ exclude_patterns = []

 html_theme = "furo"
 html_static_path = ["_static"]
+
+html_theme_options = {
+    "footer_icons": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/jeertmans/manim-slides",
+            "html": """
+                <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
+                    <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
+                </svg>
+            """,
+            "class": "",
+        },
+    ],
+    "source_repository": "https://github.com/jeertmans/manim-slides/",
+    "source_branch": "main",
+    "source_directory": "docs/source/",
+}
+
+## -- Intersphinx mapping
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "manim": ("https://docs.manim.community/en/stable/", None),
+    "manimlib": ("https://3b1b.github.io/manim/", None),
+}
--- a/docs/source/contributing/index.md
+++ b/docs/source/contributing/index.md
@ -0,0 +1,21 @@
+# Contributing
+
+Thank you for your interest in Manim Slides! ✨
+
+Manim Slides is an open source project, first created as a fork of [manim-presentation](https://github.com/galatolofederico/manim-presentation) (now deprecated in favor to Manim Slides), and we welcome contributions of all forms.
+
+This section is here to help fist-time contributors know how they can help this project grow. Whether you are already familiar with Manim or GitHub, it is worth taking a few minutes to read those documents!
+
+
+```{toctree}
+:hidden:
+
+workflow
+internals
+```
+
+[Workflow](./workflow)
+: how to work on this project. Start here if you're a new contributor.
+
+[Internals](./internals)
+: how Manim Slides is built and how the various parts of it work.
--- a/docs/source/contributing/internals.md
+++ b/docs/source/contributing/internals.md
@ -0,0 +1,11 @@
+# Internals
+
+Manim-Slides' work in split in two steps: first, when rendering animation, and, second, when converting multiple animations into one slides presentation.
+
+## Rendering
+
+To render animations, Manim Slides simply uses Manim or ManimGL, and creates some additional output files that it needs for the presentation.
+
+## Slides presentation
+
+Manim Slides searches for the local artifacts it generated previously, and concatenates them into one presentation. For the graphical interface, it uses `PySide6`.
--- a/docs/source/contributing/workflow.md
+++ b/docs/source/contributing/workflow.md
@ -0,0 +1,57 @@
+# Workflow
+
+This document is there to help you recreate a working environment for Manim Slides.
+
+## Dependencies
+
+```{include} ../../../README.md
+:start-after: <!-- start deps -->
+:end-before: <!-- end deps -->
+```
+
+## Forking the repository and cloning it locally
+
+We used GitHub to host Manim Slides' repository, and we encourage contributors to use git.
+
+Useful links:
+
+* [GitHub's Hello World](https://docs.github.com/en/get-started/quickstart/hello-world).
+* [GitHub Pull Request in 100 Seconds](https://www.youtube.com/watch?v=8lGpZkjnkt4&ab_channel=Fireship).
+
+Once you feel comfortable with git and GitHub, [fork](https://github.com/jeertmans/manim-slides/fork) the repository, and clone it locally.
+
+As for every Python project, using virtual environment is recommended to avoid conflicts between modules. For Manim Slides, we use [Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer). If not already, please install it.
+
+## Installing Python modules
+
+With Poetry, installation becomes straightforward:
+
+```bash
+poetry install
+```
+
+## Running commands
+
+As modules were installed in a new Python environment, you cannot use them directly in the shell.
+Instead, you either need to prepend `poetry run` to any command, e.g.:
+
+```bash
+poetry run manim-slides wizard
+```
+
+or enter a new shell that uses this new Python environment:
+
+```
+poetry run
+manim-slides wizard
+```
+
+## Testing your code
+
+Most of the tests are done with GitHub actions, thus not on your computer. The only command you should run locally is `pre-commit run --all-files`: this runs a few linter and formatter to make sure the code quality and style stay constant across time. If a warning or an error is displayed, please fix it before going to next step.
+
+## Proposing changes
+
+Once you feel ready and think your contribution is ready to be reviewed, create a [pull request](https://github.com/jeertmans/manim-slides/pulls) and wait for a reviewer to check your work!
+
+Many thanks to you!
--- a/docs/source/index.md
+++ b/docs/source/index.md
@ -0,0 +1,41 @@
+---
+hide-toc: true
+---
+
+```{eval-rst}
+.. image:: _static/logo.png
+    :width: 600px
+    :align: center
+    :alt: Manim Slide logo
+```
+
+# Welcome to Manim Slide's documentation
+
+Manim Slides makes creating slides with Manim super easy!
+
+In a [very few steps](./quickstart), you can create slides and present them either using the GUI, or your browser.
+
+
+Slide through the demo below to get a quick glimpse on what you can do with Manin Slides.
+
+
+<!-- From: https://faq.dailymotion.com/hc/en-us/articles/360022841393-How-to-preserve-the-player-aspect-ratio-on-a-responsive-page -->
+
+<div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="_static/slides.html"></iframe></div>
+
+
+```{toctree}
+:hidden:
+
+quickstart
+reference/index
+```
+
+```{toctree}
+:caption: Development
+:hidden:
+
+contributing/index
+changelog
+license
+```
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@ -1,28 +0,0 @@
-.. manim-slides documentation master file, created by
-   sphinx-quickstart on Wed Sep 21 15:07:28 2022.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-.. image:: _static/logo.png
-    :width: 600px
-    :align: center
-    :alt: Manim Slide logo
-
-Welcome to Manim Slide's CLI documentation!
-===========================================
-
-
-.. raw:: html
-
-   <!-- From: https://faq.dailymotion.com/hc/en-us/articles/360022841393-How-to-preserve-the-player-aspect-ratio-on-a-responsive-page -->
-
-   <div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="_static/slides.html"></iframe></div>
-
-
-This page contains an exhaustive list of all the commands available with `manim-slides`.
-
-If you need help installing or using Manim Slide, please refer to the `GitHub README <https://github.com/jeertmans/manim-slides>`_.
-
-.. click:: manim_slides.__main__:cli
-    :prog: manim-slides
-    :nested: full
--- a/docs/source/license.md
+++ b/docs/source/license.md
@ -0,0 +1,5 @@
+# License
+
+
+```{include} ../../LICENSE.md
+```
--- a/docs/source/quickstart.md
+++ b/docs/source/quickstart.md
@ -0,0 +1,21 @@
+# Quickstart
+
+## Installation
+
+```{include} ../../README.md
+:start-after: <!-- start install -->
+:end-before: <!-- end install -->
+```
+
+## Creating your first slides
+
+```{include} ../../README.md
+:start-after: <!-- start usage -->
+:end-before: <!-- end usage -->
+```
+
+The output slides should look this this:
+
+<div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="_static/basic_example.html"></iframe></div>
+
+For more advanced examples, see the [Examples](reference/examples) section.
--- a/docs/source/reference/api.md
+++ b/docs/source/reference/api.md
@ -0,0 +1,13 @@
+# Application Programming Interface
+
+Manim Slides' API is very limited: it simply consists in two classes, `Slide` and `ThreeDSlide`, which are subclasses of `Scene` and `ThreeDScene` from Manim.
+
+Thefore, we only document here the methods we think the end-user will ever use, not the methods used internally when rendering.
+
+```{eval-rst}
+.. autoclass:: manim_slides.Slide
+    :members: start_loop, end_loop, pause, play
+
+.. autoclass:: manim_slides.ThreeDSlide
+    :members:
+```
--- a/docs/source/reference/cli.md
+++ b/docs/source/reference/cli.md
@ -0,0 +1,10 @@
+# Command Line Interface
+
+This page contains an exhaustive list of all the commands available with `manim-slides`.
+
+
+```{eval-rst}
+.. click:: manim_slides.__main__:cli
+    :prog: manim-slides
+    :nested: full
+```
--- a/docs/source/reference/examples.md
+++ b/docs/source/reference/examples.md
@ -0,0 +1,80 @@
+# Examples
+
+Contents of `example.py`.
+
+Do not forget to import Manim Slides and Manim or ManimGL:
+
+```python
+from manim import *
+from manim_slides import Slide, ThreeDSlide
+```
+
+or
+
+```python
+from manimlib import *
+from manim_slides import Slide, ThreeDSlide
+```
+
+Then, each presentation, named `SCENE`, was generated with those two commands:
+
+```bash
+manim example.py SCENE # or manimgl example SCENE
+manim-slides convert SCENE -ccontrols=true
+```
+
+where `-ccontrols=true` indicates that we want to display the blue navigation arrows.
+
+## Basic Example
+
+Basic example from quickstart.
+
+<div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="../_static/basic_example.html"></iframe></div>
+
+```{eval-rst}
+.. literalinclude:: ../../../example.py
+   :language: python
+   :linenos:
+   :pyobject: BasicExample
+```
+
+## 3D Example
+
+Example using 3D camera. As Manim and ManimGL handle 3D differently, definitions are slightly different.
+
+<div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="../_static/three_d_example.html"></iframe></div>
+
+### With Manim
+
+```{eval-rst}
+.. literalinclude:: ../../../example.py
+   :language: python
+   :linenos:
+   :dedent: 4
+   :start-after: [manim-3d]
+   :end-before: [manim-3d]
+```
+
+### With ManimGL
+
+```{eval-rst}
+.. literalinclude:: ../../../example.py
+   :language: python
+   :linenos:
+   :dedent: 4
+   :start-after: [manimgl-3d]
+   :end-before: [manimgl-3d]
+```
+
+## Advanced Example
+
+A more advanced example is `ConvertExample`, which is used as demo slide and tutorial.
+
+<div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="../_static/slides.html"></iframe></div>
+
+```{eval-rst}
+.. literalinclude:: ../../../example.py
+   :language: python
+   :linenos:
+   :pyobject: ConvertExample
+```
--- a/docs/source/reference/index.md
+++ b/docs/source/reference/index.md
@ -0,0 +1,17 @@
+# Reference Documentation
+
+Automatically generated reference for Manim Slides.
+
+```{toctree}
+:hidden:
+
+api
+cli
+examples
+```
+
+[Application Programming Interface](./api): list of classes and methods that may be useful to the end-user.
+
+[Command Line Interface](./cli): list of all commands available using Manim Slides' executable.
+
+[Examples](./examples): curated list of examples and their output.
--- a/example.py
+++ b/example.py
@ -16,30 +16,20 @@ else:
 from manim_slides import Slide, ThreeDSlide


-class Example(Slide):
+class BasicExample(Slide):
    def construct(self):
        circle = Circle(radius=3, color=BLUE)
        dot = Dot()

        self.play(GrowFromCenter(circle))
-        self.pause()
+        self.pause()  # Waits user to press continue to go to the next slide

-        self.start_loop()
+        self.start_loop()  # Start loop
        self.play(MoveAlongPath(dot, circle), run_time=2, rate_func=linear)
-        self.end_loop()
+        self.end_loop()  # This will loop until user inputs a key

        self.play(dot.animate.move_to(ORIGIN))
-        self.pause()
-
-        self.play(dot.animate.move_to(RIGHT * 3))
-        self.pause()
-
-        self.start_loop()
-        self.play(MoveAlongPath(dot, circle), run_time=2, rate_func=linear)
-        self.end_loop()
-
-        # Each slide MUST end with an animation (a self.wait is considered an animation)
-        self.play(dot.animate.move_to(ORIGIN))
+        self.pause()  # Waits user to press continue to go to the next slide


 class ConvertExample(Slide):
@ -261,6 +251,7 @@ class Example(Slide):

 if not MANIMGL:

+    # [manim-3d]
    class ThreeDExample(ThreeDSlide):
        def construct(self):
            axes = ThreeDAxes()
@ -296,7 +287,9 @@ if not MANIMGL:
            # Each slide MUST end with an animation (a self.wait is considered an animation)
            self.play(dot.animate.move_to(ORIGIN))

+    # [manim-3d]
 else:
+    # [manimgl-3d]
    # WARNING: 3b1b's manim change how ThreeDScene work,
    # this is why things have to be managed differently.
    class ThreeDExample(Slide):
@ -342,3 +335,5 @@ else:

            # Each slide MUST end with an animation (a self.wait is considered an animation)
            self.play(dot.animate.move_to(ORIGIN))
+
+    # [manimgl-3d]
--- a/manim_slides/version.py
+++ b/manim_slides/version.py
@ -1 +1 @@
-__version__ = "4.7.1"
+__version__ = "4.8.2"
--- a/manim_slides/config.py
+++ b/manim_slides/config.py
@ -206,7 +206,7 @@ class PresentationConfig(BaseModel):  # type: ignore
                dest_path = merge_basenames(files)

                f = tempfile.NamedTemporaryFile(mode="w", delete=False)
-                f.writelines(f"file {os.path.abspath(path)}\n" for path in files)
+                f.writelines(f"file '{os.path.abspath(path)}'\n" for path in files)
                f.close()

                command = [
--- a/manim_slides/convert.py
+++ b/manim_slides/convert.py
@ -1,12 +1,12 @@
 import os
 import webbrowser
 from enum import Enum
-from typing import Any, Callable, Dict, Generator, List, Type
+from typing import Any, Callable, Dict, Generator, List, Optional, Type, Union

 import click
 import pkg_resources
 from click import Context, Parameter
-from pydantic import BaseModel
+from pydantic import BaseModel, PositiveInt, ValidationError

 from .commons import folder_path_option, verbosity_option
 from .config import PresentationConfig
@ -34,14 +34,21 @@ def validate_config_option(
 class Converter(BaseModel):  # type: ignore
    presentation_configs: List[PresentationConfig] = []
    assets_dir: str = "{basename}_assets"
+    template: Optional[str] = None

    def convert_to(self, dest: str) -> None:
        """Converts self, i.e., a list of presentations, into a given format."""
        raise NotImplementedError

+    def load_template(self) -> str:
+        """Returns the template as a string.
+
+        An empty string is returned if no template is used."""
+        return ""
+
    def open(self, file: str) -> bool:
        """Opens a file, generated with converter, using appropriate application."""
-        return webbrowser.open(file)
+        raise NotImplementedError

    @classmethod
    def from_string(cls, s: str) -> Type["Converter"]:
@ -51,11 +58,126 @@ class Converter(BaseModel):  # type: ignore
        }[s]


-class JSBool(str, Enum):
+class Str(str):
+    """A simple string, but quoted when needed."""
+
+    # This fixes pickling issue on Python 3.8
+    __reduce_ex__ = str.__reduce_ex__
+
+    def __str__(self) -> str:
+        """Ensures that the string is correctly quoted."""
+        if self in ["true", "false", "null"]:
+            return super().__str__()
+        else:
+            return f"'{super().__str__()}'"
+
+
+Function = str  # Basically, anything
+
+
+class JsTrue(str, Enum):
+    true = "true"
+
+
+class JsFalse(str, Enum):
+    false = "false"
+
+
+class JsBool(Str, Enum):  # type: ignore
    true = "true"
    false = "false"


+class JsNull(Str, Enum):  # type: ignore
+    null = "null"
+
+
+class ControlsLayout(Str, Enum):  # type: ignore
+    edges = "edges"
+    bottom_right = "bottom-right"
+
+
+class ControlsBackArrows(Str, Enum):  # type: ignore
+    faded = "faded"
+    hidden = "hidden"
+    visibly = "visibly"
+
+
+class SlideNumber(Str, Enum):  # type: ignore
+    true = "true"
+    false = "false"
+    hdotv = "h.v"
+    handv = "h/v"
+    c = "c"
+    candt = "c/t"
+
+
+class ShowSlideNumber(Str, Enum):  # type: ignore
+    all = "all"
+    print = "print"
+    speaker = "speaker"
+
+
+class KeyboardCondition(Str, Enum):  # type: ignore
+    null = "null"
+    focused = "focused"
+
+
+class NavigationMode(Str, Enum):  # type: ignore
+    default = "default"
+    linear = "linear"
+    grid = "grid"
+
+
+class AutoPlayMedia(Str, Enum):  # type: ignore
+    null = "null"
+    true = "true"
+    false = "false"
+
+
+PreloadIframes = AutoPlayMedia
+
+
+class AutoAnimateMatcher(Str, Enum):  # type: ignore
+    null = "null"
+
+
+class AutoAnimateEasing(Str, Enum):  # type: ignore
+    ease = "ease"
+
+
+AutoSlide = Union[PositiveInt, JsFalse]
+
+
+class AutoSlideMethod(Str, Enum):  # type: ignore
+    null = "null"
+
+
+MouseWheel = Union[JsNull, float]
+
+
+class Transition(Str, Enum):  # type: ignore
+    none = "none"
+    fade = "fade"
+    slide = "slide"
+    convex = "convex"
+    concave = "concave"
+    zoom = "zoom"
+
+
+class TransitionSpeed(Str, Enum):  # type: ignore
+    default = "default"
+    fast = "fast"
+    slow = "slow"
+
+
+BackgroundTransition = Transition
+
+
+class Display(Str, Enum):  # type: ignore
+    block = "block"
+
+
 class RevealTheme(str, Enum):
    black = "black"
    white = "white"
@ -71,21 +193,90 @@ class RevealTheme(str, Enum):


 class RevealJS(Converter):
-    background_color: str = "black"
-    controls: JSBool = JSBool.false
-    embedded: JSBool = JSBool.false
-    fragments: JSBool = JSBool.false
-    height: str = "100%"
-    loop: JSBool = JSBool.false
-    progress: JSBool = JSBool.false
-    reveal_version: str = "3.7.0"
+    # Presentation size options from RevealJS
+    width: Union[Str, int] = Str("100%")
+    height: Union[Str, int] = Str("100%")
+    margin: float = 0.04
+    min_scale: float = 0.2
+    max_scale: float = 2.0
+    # Configuration options from RevealJS
+    controls: JsBool = JsBool.false
+    controls_tutorial: JsBool = JsBool.true
+    controls_layout: ControlsLayout = ControlsLayout.bottom_right
+    controls_back_arrows: ControlsBackArrows = ControlsBackArrows.faded
+    progress: JsBool = JsBool.false
+    slide_number: SlideNumber = SlideNumber.false
+    show_slide_number: Union[ShowSlideNumber, Function] = ShowSlideNumber.all
+    hash_one_based_index: JsBool = JsBool.false
+    hash: JsBool = JsBool.false
+    respond_to_hash_changes: JsBool = JsBool.false
+    history: JsBool = JsBool.false
+    keyboard: JsBool = JsBool.true
+    keyboard_condition: Union[KeyboardCondition, Function] = KeyboardCondition.null
+    disable_layout: JsBool = JsBool.false
+    overview: JsBool = JsBool.true
+    center: JsBool = JsBool.true
+    touch: JsBool = JsBool.true
+    loop: JsBool = JsBool.false
+    rtl: JsBool = JsBool.false
+    navigation_mode: NavigationMode = NavigationMode.default
+    shuffle: JsBool = JsBool.false
+    fragments: JsBool = JsBool.true
+    fragment_in_url: JsBool = JsBool.true
+    embedded: JsBool = JsBool.false
+    help: JsBool = JsBool.true
+    pause: JsBool = JsBool.true
+    show_notes: JsBool = JsBool.false
+    auto_play_media: AutoPlayMedia = AutoPlayMedia.null
+    preload_iframes: PreloadIframes = PreloadIframes.null
+    auto_animate: JsBool = JsBool.true
+    auto_animate_matcher: Union[AutoAnimateMatcher, Function] = AutoAnimateMatcher.null
+    auto_animate_easing: AutoAnimateEasing = AutoAnimateEasing.ease
+    auto_animate_duration: float = 1.0
+    auto_animate_unmatched: JsBool = JsBool.true
+    auto_animate_styles: List[str] = [
+        "opacity",
+        "color",
+        "background-color",
+        "padding",
+        "font-size",
+        "line-height",
+        "letter-spacing",
+        "border-width",
+        "border-color",
+        "border-radius",
+        "outline",
+        "outline-offset",
+    ]
+    auto_slide: AutoSlide = 0
+    auto_slide_stoppable: JsBool = JsBool.true
+    auto_slide_method: Union[AutoSlideMethod, Function] = AutoSlideMethod.null
+    default_timing: Union[JsNull, int] = JsNull.null
+    mouse_wheel: JsBool = JsBool.false
+    preview_links: JsBool = JsBool.false
+    post_message: JsBool = JsBool.true
+    post_message_events: JsBool = JsBool.false
+    focus_body_on_page_visibility_change: JsBool = JsBool.true
+    transition: Transition = Transition.none
+    transition_speed: TransitionSpeed = TransitionSpeed.default
+    background_transition: BackgroundTransition = BackgroundTransition.none
+    pdf_max_pages_per_slide: Union[int, str] = "Number.POSITIVE_INFINITY"
+    pdf_separate_fragments: JsBool = JsBool.true
+    pdf_page_height_offset: int = -1
+    view_distance: int = 3
+    mobile_view_distance: int = 2
+    display: Display = Display.block
+    hide_inactive_cursor: JsBool = JsBool.true
+    hide_cursor_time: int = 5000
+    # Add. options
+    background_color: str = "black"  # TODO: use pydantic.color.Color
+    reveal_version: str = "4.4.0"
    reveal_theme: RevealTheme = RevealTheme.black
-    shuffle: JSBool = JSBool.false
    title: str = "Manim Slides"
-    width: str = "100%"

    class Config:
        use_enum_values = True
+        extra = "forbid"

    def get_sections_iter(self) -> Generator[str, None, None]:
        """Generates a sequence of sections, one per slide, that will be included into the html template."""
@ -94,17 +285,29 @@ class RevealJS(Converter):
                file = presentation_config.files[slide_config.start_animation]
                file = os.path.join(self.assets_dir, os.path.basename(file))

+                # TODO: document this
+                # Videos are muted because, otherwise, the first slide never plays correctly.
+                # This is due to a restriction in playing audio without the user doing anything.
+                # Later, this might be useful to only mute the first video, or to make it optional.
+                # Read more about this:
+                #   https://developer.mozilla.org/en-US/docs/Web/Media/Autoplay_guide#autoplay_and_autoplay_blocking
                if slide_config.is_loop():
-                    yield f'<section data-background-video="{file}" data-background-video-loop></section>'
+                    yield f'<section data-background-video="{file}" data-background-video-muted data-background-video-loop></section>'
                else:
-                    yield f'<section data-background-video="{file}"></section>'
+                    yield f'<section data-background-video="{file}" data-background-video-muted></section>'

    def load_template(self) -> str:
        """Returns the RevealJS HTML template as a string."""
+        if isinstance(self.template, str):
+            with open(self.template, "r") as f:
+                return f.read()
        return pkg_resources.resource_string(
            __name__, "data/revealjs_template.html"
        ).decode()

+    def open(self, file: str) -> bool:
+        return webbrowser.open(file)
+
    def convert_to(self, dest: str) -> None:
        """Converts this configuration into a RevealJS HTML presentation, saved to DEST."""
        dirname = os.path.dirname(dest)
@ -138,19 +341,13 @@ def show_config_options(function: Callable[..., Any]) -> Callable[..., Any]:
        if not value or ctx.resilient_parsing:
            return

-        to = ctx.params.get("to")
+        to = ctx.params.get("to", "html")

-        if to:
-            converter = Converter.from_string(to)(scenes=[])
-            for key, value in converter.dict().items():
-                click.echo(f"{key}: {repr(value)}")
+        converter = Converter.from_string(to)(presentation_configs=[])
+        for key, value in converter.dict().items():
+            click.echo(f"{key}: {repr(value)}")

-            ctx.exit()
-
-        else:
-            raise click.UsageError(
-                "Using --show-config option requires to first specify --to option."
-            )
+        ctx.exit()

    return click.option(
        "--show-config",
@ -163,6 +360,35 @@ def show_config_options(function: Callable[..., Any]) -> Callable[..., Any]:
    )(function)


+def show_template_option(function: Callable[..., Any]) -> Callable[..., Any]:
+    """Wraps a function to add a `--show-template` option."""
+
+    def callback(ctx: Context, param: Parameter, value: bool) -> None:
+
+        if not value or ctx.resilient_parsing:
+            return
+
+        to = ctx.params.get("to", "html")
+        template = ctx.params.get("template", None)
+
+        converter = Converter.from_string(to)(
+            presentation_configs=[], template=template
+        )
+        click.echo(converter.load_template())
+
+        ctx.exit()
+
+    return click.option(
+        "--show-template",
+        is_flag=True,
+        help="Show the template (currently) used for a given conversion format and exit.",
+        default=None,
+        expose_value=False,
+        show_envvar=True,
+        callback=callback,
+    )(function)
+
+
@click.command()
@click.argument("scenes", nargs=-1)
@folder_path_option
@ -187,8 +413,16 @@ def show_config_options(function: Callable[..., Any]) -> Callable[..., Any]:
    "config_options",
    multiple=True,
    callback=validate_config_option,
-    help="Configuration options passed to the converter. E.g., pass `-cbackground_color=red` to set the background color to red (if supported).",
+    help="Configuration options passed to the converter. E.g., pass `-cslide_number=true` to display slide numbers.",
 )
+@click.option(
+    "--use-template",
+    "template",
+    metavar="FILE",
+    type=click.Path(exists=True, dir_okay=False),
+    help="Use the template given by FILE instead of default one. To echo the default template, use `--show-template`.",
+)
+@show_template_option
@show_config_options
@verbosity_option
 def convert(
@ -199,6 +433,7 @@ def convert(
    open_result: bool,
    force: bool,
    config_options: Dict[str, str],
+    template: Optional[str],
 ) -> None:
    """
    Convert SCENE(s) into a given format and writes the result in DEST.
@ -206,11 +441,29 @@ def convert(

    presentation_configs = get_scenes_presentation_config(scenes, folder)

-    converter = Converter.from_string(to)(
-        presentation_configs=presentation_configs, **config_options
-    )
+    try:
+        converter = Converter.from_string(to)(
+            presentation_configs=presentation_configs,
+            template=template,
+            **config_options,
+        )

-    converter.convert_to(dest)
+        converter.convert_to(dest)

-    if open_result:
-        converter.open(dest)
+        if open_result:
+            converter.open(dest)
+
+    except ValidationError as e:
+
+        errors = e.errors()
+
+        msg = [
+            f"{len(errors)} error(s) occured with configuration options for '{to}', see below."
+        ]
+
+        for error in errors:
+            option = error["loc"][0]
+            _msg = error["msg"]
+            msg.append(f"Option '{option}': {_msg}")
+
+        raise click.UsageError("\n".join(msg))
--- a/manim_slides/data/revealjs_template.html
+++ b/manim_slides/data/revealjs_template.html
@ -1,185 +1,291 @@
 <!doctype html>
 <html>

-<head>
-	<meta charset="utf-8">
-	<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no">

-	<title>{title}</title>
+    <title>{title}</title>

-	<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/reveal.js@{reveal_version}/css/reveal.css">
-	<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/reveal.js@{reveal_version}/css/theme/{reveal_theme}.css">
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/reveal.js/{reveal_version}/reveal.min.css">
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/reveal.js/{reveal_version}/theme/{reveal_theme}.min.css">

-	<!-- Theme used for syntax highlighting of code -->
-	<!-- <link rel="stylesheet" href="lib/css/zenburn.css"> -->
-	<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/zenburn.min.css">
+    <!-- Theme used for syntax highlighting of code -->
+    <!-- <link rel="stylesheet" href="lib/css/zenburn.css"> -->
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/zenburn.min.css">

-	<!-- Printing and PDF exports -->
-	<script>
-		var link = document.createElement('link');
-		link.rel = 'stylesheet';
-		link.type = 'text/css';
-		link.href = window.location.search.match(/print-pdf/gi) ? 'https://cdn.jsdelivr.net/npm/reveal.js@{reveal_version}/css/print/pdf.css' : 'https://cdn.jsdelivr.net/npm/reveal.js@{reveal_version}/css/print/paper.css';
-		document.getElementsByTagName('head')[0].appendChild(link);
-	</script>
-	<!-- <link rel="stylesheet" href="index.css"> -->
-</head>
+    <!-- <link rel="stylesheet" href="index.css"> -->
+  </head>

-<body>
-	<div class="reveal">
-		<div class="slides">
-            {sections}
-		</div>
-	</div>
+  <body>
+    <div class="reveal">
+      <div class="slides">
+        {sections}
+      </div>
+    </div>

-	<!--<script src="lib/js/head.min.js"></script>-->
-	<script src="https://cdn.jsdelivr.net/npm/headjs@1.0.3/dist/1.0.0/head.min.js"></script>
-	<script src="https://cdn.jsdelivr.net/npm/reveal.js@{reveal_version}/js/reveal.min.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/reveal.js/{reveal_version}/reveal.min.js"></script>

-	<!-- <script src="index.js"></script> -->
-	<script>
-		// More info about config & dependencies:
-		// - https://github.com/hakimel/reveal.js#configuration
-		// - https://github.com/hakimel/reveal.js#dependencies
-		Reveal.initialize({{
-			// Display controls in the bottom right corner
-			controls: {controls},
+    <!-- To include plugins, see: https://revealjs.com/plugins/ -->

-			width: '{width}',
-			height: '{height}',
+    <!-- <script src="index.js"></script> -->
+    <script>
+      Reveal.initialize({{

-			// Display a presentation progress bar
-			progress: {progress},
+                // The "normal" size of the presentation, aspect ratio will
+                // be preserved when the presentation is scaled to fit different
+                // resolutions. Can be specified using percentage units.
+                width: {width},
+                height: {height},

-			// Set default timing of 2 minutes per slide
-			defaultTiming: 120,
+                // Factor of the display size that should remain empty around
+                // the content
+                margin: {margin},

-			// Display the page number of the current slide
-			slideNumber: true,
+                // Bounds for smallest/largest possible scale to apply to content
+                minScale: {min_scale},
+                maxScale: {max_scale},

-			// Push each slide change to the browser history
-			history: false,
+                // Display presentation control arrows
+                controls: {controls},

-			// Enable keyboard shortcuts for navigation
-			keyboard: true,
+                // Help the user learn the controls by providing hints, for example by
+                // bouncing the down arrow when they first encounter a vertical slide
+                controlsTutorial: {controls_tutorial},

-			// Enable the slide overview mode
-			overview: true,
+                // Determines where controls appear, "edges" or "bottom-right"
+                controlsLayout: {controls_layout},

-			// Vertical centering of slides
-			center: true,
+                // Visibility rule for backwards navigation arrows; "faded", "hidden"
+                // or "visible"
+                controlsBackArrows: {controls_back_arrows},

-			// Enables touch navigation on devices with touch input
-			touch: true,
+                // Display a presentation progress bar
+                progress: {progress},

-			// Loop the presentation
-			loop: {loop},
+                // Display the page number of the current slide
+                // - true:    Show slide number
+                // - false:   Hide slide number
+                //
+                // Can optionally be set as a string that specifies the number formatting:
+                // - "h.v":   Horizontal . vertical slide number (default)
+                // - "h/v":   Horizontal / vertical slide number
+                // - "c":   Flattened slide number
+                // - "c/t":   Flattened slide number / total slides
+                //
+                // Alternatively, you can provide a function that returns the slide
+                // number for the current slide. The function should take in a slide
+                // object and return an array with one string [slideNumber] or
+                // three strings [n1,delimiter,n2]. See #formatSlideNumber().
+                slideNumber: {slide_number},

-			// Change the presentation direction to be RTL
-			rtl: false,
+                // Can be used to limit the contexts in which the slide number appears
+                // - "all":      Always show the slide number
+                // - "print":    Only when printing to PDF
+                // - "speaker":  Only in the speaker view
+                showSlideNumber: {show_slide_number},

-			// Randomizes the order of slides each time the presentation loads
-			shuffle: {shuffle},
+                // Use 1 based indexing for # links to match slide number (default is zero
+                // based)
+                hashOneBasedIndex: {hash_one_based_index},

-			// Turns fragments on and off globally
-			fragments: {fragments},
+                // Add the current slide number to the URL hash so that reloading the
+                // page/copying the URL will return you to the same slide
+                hash: {hash},

-			// Flags if the presentation is running in an embedded mode,
-			// i.e. contained within a limited portion of the screen
-			embedded: {embedded},
+                // Flags if we should monitor the hash and change slides accordingly
+                respondToHashChanges: {respond_to_hash_changes},

-			// Flags if we should show a help overlay when the questionmark
-			// key is pressed
-			help: true,
+                // Push each slide change to the browser history.  Implies `hash: true`
+                history: {history},

-			// Flags if speaker notes should be visible to all viewers
-			showNotes: false,
+                // Enable keyboard shortcuts for navigation
+                keyboard: {keyboard},

-			// Global override for autolaying embedded media (video/audio/iframe)
-			// - null: Media will only autoplay if data-autoplay is present
-			// - true: All media will autoplay, regardless of individual setting
-			// - false: No media will autoplay, regardless of individual setting
-			autoPlayMedia: null,
+                // Optional function that blocks keyboard events when retuning false
+                //
+                // If you set this to 'focused', we will only capture keyboard events
+                // for embedded decks when they are in focus
+                keyboardCondition: {keyboard_condition},

-			// Number of milliseconds between automatically proceeding to the
-			// next slide, disabled when set to 0, this value can be overwritten
-			// by using a data-autoslide attribute on your slides
-			autoSlide: 0,
+                // Disables the default reveal.js slide layout (scaling and centering)
+                // so that you can use custom CSS layout
+                disableLayout: {disable_layout},

-			// Stop auto-sliding after user input
-			autoSlideStoppable: true,
+                // Enable the slide overview mode
+                overview: {overview},

-			// Use this method for navigation when auto-sliding
-			autoSlideMethod: Reveal.navigateNext,
+                // Vertical centering of slides
+                center: {center},

-			// Enable slide navigation via mouse wheel
-			mouseWheel: false,
+                // Enables touch navigation on devices with touch input
+                touch: {touch},

-			// Hides the address bar on mobile devices
-			hideAddressBar: true,
+                // Loop the presentation
+                loop: {loop},

-			// Opens links in an iframe preview overlay
-			previewLinks: true,
+                // Change the presentation direction to be RTL
+                rtl: {rtl},

-			// Transition style
-			transition: 'none', // none/fade/slide/convex/concave/zoom
+                // Changes the behavior of our navigation directions.
+                //
+                // "default"
+                // Left/right arrow keys step between horizontal slides, up/down
+                // arrow keys step between vertical slides. Space key steps through
+                // all slides (both horizontal and vertical).
+                //
+                // "linear"
+                // Removes the up/down arrows. Left/right arrows step through all
+                // slides (both horizontal and vertical).
+                //
+                // "grid"
+                // When this is enabled, stepping left/right from a vertical stack
+                // to an adjacent vertical stack will land you at the same vertical
+                // index.
+                //
+                // Consider a deck with six slides ordered in two vertical stacks:
+                // 1.1    2.1
+                // 1.2    2.2
+                // 1.3    2.3
+                //
+                // If you're on slide 1.3 and navigate right, you will normally move
+                // from 1.3 -> 2.1. If "grid" is used, the same navigation takes you
+                // from 1.3 -> 2.3.
+                navigationMode: {navigation_mode},

-			// Transition speed
-			transitionSpeed: 'default', // default/fast/slow
+                // Randomizes the order of slides each time the presentation loads
+                shuffle: {shuffle},

-			// Transition style for full page slide backgrounds
-			backgroundTransition: 'none', // none/fade/slide/convex/concave/zoom
+                // Turns fragments on and off globally
+                fragments: {fragments},

-			// Number of slides away from the current that are visible
-			viewDistance: 3,
+                // Flags whether to include the current fragment in the URL,
+                // so that reloading brings you to the same fragment position
+                fragmentInURL: {fragment_in_url},

-			// Parallax background image
-			parallaxBackgroundImage: '', // e.g. "'https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg'"
+                // Flags if the presentation is running in an embedded mode,
+                // i.e. contained within a limited portion of the screen
+                embedded: {embedded},

-			// Parallax background size
-			parallaxBackgroundSize: '', // CSS syntax, e.g. "2100px 900px"
+                // Flags if we should show a help overlay when the question-mark
+                // key is pressed
+                help: {help},

-			// Number of pixels to move the parallax background per slide
-			// - Calculated automatically unless specified
-			// - Set to 0 to disable movement along an axis
-			parallaxBackgroundHorizontal: null,
-			parallaxBackgroundVertical: null,
+                // Flags if it should be possible to pause the presentation (blackout)
+                pause: {pause},
+
+                // Flags if speaker notes should be visible to all viewers
+                showNotes: {show_notes},
+
+                // Global override for autolaying embedded media (video/audio/iframe)
+                // - null:   Media will only autoplay if data-autoplay is present
+                // - true:   All media will autoplay, regardless of individual setting
+                // - false:  No media will autoplay, regardless of individual setting
+                autoPlayMedia: {auto_play_media},
+
+                // Global override for preloading lazy-loaded iframes
+                // - null:   Iframes with data-src AND data-preload will be loaded when within
+                //           the viewDistance, iframes with only data-src will be loaded when visible
+                // - true:   All iframes with data-src will be loaded when within the viewDistance
+                // - false:  All iframes with data-src will be loaded only when visible
+                preloadIframes: {preload_iframes},
+
+                // Can be used to globally disable auto-animation
+                autoAnimate: {auto_animate},
+
+                // Optionally provide a custom element matcher that will be
+                // used to dictate which elements we can animate between.
+                autoAnimateMatcher: {auto_animate_matcher},
+
+                // Default settings for our auto-animate transitions, can be
+                // overridden per-slide or per-element via data arguments
+                autoAnimateEasing: {auto_animate_easing},
+                autoAnimateDuration: {auto_animate_duration},
+                autoAnimateUnmatched: {auto_animate_unmatched},
+
+                // CSS properties that can be auto-animated. Position & scale
+                // is matched separately so there's no need to include styles
+                // like top/right/bottom/left, width/height or margin.
+                autoAnimateStyles: {auto_animate_styles},
+
+                // Controls automatic progression to the next slide
+                // - 0:      Auto-sliding only happens if the data-autoslide HTML attribute
+                //           is present on the current slide or fragment
+                // - 1+:     All slides will progress automatically at the given interval
+                // - false:  No auto-sliding, even if data-autoslide is present
+                autoSlide: {auto_slide},
+
+                // Stop auto-sliding after user input
+                autoSlideStoppable: {auto_slide_stoppable},
+
+                // Use this method for navigation when auto-sliding (defaults to navigateNext)
+                autoSlideMethod: {auto_slide_method},
+
+                // Specify the average time in seconds that you think you will spend
+                // presenting each slide. This is used to show a pacing timer in the
+                // speaker view
+                defaultTiming: {default_timing},
+
+                // Enable slide navigation via mouse wheel
+                mouseWheel: {mouse_wheel},
+
+                // Opens links in an iframe preview overlay
+                // Add `data-preview-link` and `data-preview-link="false"` to customise each link
+                // individually
+                previewLinks: {preview_links},
+
+                // Exposes the reveal.js API through window.postMessage
+                postMessage: {post_message},
+
+                // Dispatches all reveal.js events to the parent window through postMessage
+                postMessageEvents: {post_message_events},
+
+                // Focuses body when page changes visibility to ensure keyboard shortcuts work
+                focusBodyOnPageVisibilityChange: {focus_body_on_page_visibility_change},
+
+                // Transition style
+                transition: {transition}, // none/fade/slide/convex/concave/zoom
+
+                // Transition speed
+                transitionSpeed: {transition_speed}, // default/fast/slow
+
+                // Transition style for full page slide backgrounds
+                backgroundTransition: {background_transition}, // none/fade/slide/convex/concave/zoom
+
+                // The maximum number of pages a single slide can expand onto when printing
+                // to PDF, unlimited by default
+                pdfMaxPagesPerSlide: {pdf_max_pages_per_slide},
+
+                // Prints each fragment on a separate slide
+                pdfSeparateFragments: {pdf_separate_fragments},
+
+                // Offset used to reduce the height of content within exported PDF pages.
+                // This exists to account for environment differences based on how you
+                // print to PDF. CLI printing options, like phantomjs and wkpdf, can end
+                // on precisely the total height of the document whereas in-browser
+                // printing has to end one pixel before.
+                pdfPageHeightOffset: {pdf_page_height_offset},
+
+                // Number of slides away from the current that are visible
+                viewDistance: {view_distance},
+
+                // Number of slides away from the current that are visible on mobile
+                // devices. It is advisable to set this to a lower number than
+                // viewDistance in order to save resources.
+                mobileViewDistance: {mobile_view_distance},
+
+                // The display mode that will be used to show slides
+                display: {display},
+
+                // Hide cursor if inactive
+                hideInactiveCursor: {hide_inactive_cursor},
+
+                // Time before the cursor is hidden (in ms)
+                hideCursorTime: {hide_cursor_time}


-			// The display mode that will be used to show slides
-			display: 'block',
-
-			/*
-			multiplex: {{
-				// Example values. To generate your own, see the socket.io server instructions.
-				secret: '13652805320794272084', // Obtained from the socket.io server. Gives this (the master) control of the presentation
-				id: '1ea875674b17ca76', // Obtained from socket.io server
-				url: 'https://reveal-js-multiplex-ccjbegmaii.now.sh' // Location of socket.io server
-			}},
-			*/
-
-			dependencies: [
-				{{ src: 'https://cdn.jsdelivr.net/npm/reveal.js@{reveal_version}/plugin/markdown/marked.js' }},
-				{{ src: 'https://cdn.jsdelivr.net/npm/reveal.js@{reveal_version}/plugin/markdown/markdown.js' }},
-				{{ src: 'https://cdn.jsdelivr.net/npm/reveal.js@{reveal_version}/plugin/notes/notes.js', async: true }},
-				{{ src: 'https://cdn.jsdelivr.net/npm/reveal.js@{reveal_version}/plugin/highlight/highlight.js', async: true, callback: function () {{ hljs.initHighlightingOnLoad(); }} }},
-				//{{ src: '//cdn.socket.io/socket.io-1.3.5.js', async: true }},
-				//{{ src: 'plugin/multiplex/master.js', async: true }},
-				// and if you want speaker notes
-				{{ src: 'https://cdn.jsdelivr.net/npm/reveal.js@{reveal_version}/plugin/notes-server/client.js', async: true }}
-
-			],
-			markdown: {{
-				//            renderer: myrenderer,
-				smartypants: true
-			}}
-		}});
-		Reveal.configure({{
-			// PDF Configurations
-			pdfMaxPagesPerSlide: 1
-
-		}});
-	</script>
-</body>
+            }});
+    </script>
+  </body>

 </html>
--- a/manim_slides/present.py
+++ b/manim_slides/present.py
@ -2,7 +2,7 @@ import os
 import platform
 import sys
 import time
-from enum import IntEnum, auto, unique
+from enum import Enum, IntEnum, auto, unique
 from typing import Any, Dict, List, Optional, Tuple, Union

 import click
@ -28,9 +28,17 @@ WINDOW_NAME = "Manim Slides"
 WINDOW_INFO_NAME = f"{WINDOW_NAME}: Info"
 WINDOWS = platform.system() == "Windows"

+
+class AspectRatio(Enum):
+    ignore = Qt.IgnoreAspectRatio
+    keep = Qt.KeepAspectRatio
+    auto = "auto"
+
+
 ASPECT_RATIO_MODES = {
-    "ignore": Qt.IgnoreAspectRatio,
-    "keep": Qt.KeepAspectRatio,
+    "ignore": AspectRatio.ignore,
+    "keep": AspectRatio.keep,
+    "auto": AspectRatio.auto,
 }

 RESIZE_MODES = {
@ -514,7 +522,7 @@ class App(QWidget):  # type: ignore
        fullscreen: bool = False,
        resolution: Tuple[int, int] = (1980, 1080),
        hide_mouse: bool = False,
-        aspect_ratio: Qt.AspectRatioMode = Qt.IgnoreAspectRatio,
+        aspect_ratio: AspectRatio = AspectRatio.auto,
        resize_mode: Qt.TransformationMode = Qt.SmoothTransformation,
        background_color: str = "black",
        **kwargs: Any,
@ -533,6 +541,9 @@ class App(QWidget):  # type: ignore
            self.setCursor(Qt.BlankCursor)

        self.label = QLabel(self)
+
+        if self.aspect_ratio == AspectRatio.auto:
+            self.label.setScaledContents(True)
        self.label.setAlignment(Qt.AlignCenter)
        self.label.resize(self.display_width, self.display_height)
        self.label.setStyleSheet(f"background-color: {background_color}")
@ -584,10 +595,11 @@ class App(QWidget):  # type: ignore
        self.deleteLater()

    def resizeEvent(self, event: QResizeEvent) -> None:
-        self.pixmap = self.pixmap.scaled(
-            self.width(), self.height(), self.aspect_ratio, self.resize_mode
-        )
-        self.label.setPixmap(self.pixmap)
+        if not self.label.hasScaledContents():
+            self.pixmap = self.pixmap.scaled(
+                self.width(), self.height(), self.aspect_ratio.value, self.resize_mode
+            )
+            self.label.setPixmap(self.pixmap)
        self.label.resize(self.width(), self.height())

    def closeEvent(self, event: QCloseEvent) -> None:
@ -601,9 +613,11 @@ class App(QWidget):  # type: ignore
        bytes_per_line = ch * w
        qt_img = QImage(cv_img.data, w, h, bytes_per_line, QImage.Format_BGR888)

-        if w != self.width() or h != self.height():
+        if not self.label.hasScaledContents() and (
+            w != self.width() or h != self.height()
+        ):
            qt_img = qt_img.scaled(
-                self.width(), self.height(), self.aspect_ratio, self.resize_mode
+                self.width(), self.height(), self.aspect_ratio.value, self.resize_mode
            )

        self.label.setPixmap(QPixmap.fromImage(qt_img))
@ -755,8 +769,8 @@ def get_scenes_presentation_config(
@click.option(
    "--aspect-ratio",
    type=click.Choice(ASPECT_RATIO_MODES.keys(), case_sensitive=False),
-    default="ignore",
-    help="Set the aspect ratio mode to be used when rescaling video.",
+    default="auto",
+    help="Set the aspect ratio mode to be used when rescaling video. `'auto'` option is equivalent to `'ignore'`, but can be much faster due to not calling `scaled()` method on every frame.",
    show_default=True,
 )
@click.option(
@ -845,4 +859,3 @@ def present(
    )
    a.show()
    sys.exit(app.exec_())
-    logger.debug("After")
--- a/manim_slides/slide.py
+++ b/manim_slides/slide.py
@ -27,7 +27,7 @@ def reverse_video_file(src: str, dst: str) -> None:

 class Slide(Scene):  # type:ignore
    """
-    Inherits from `manim.Scene` or `manimlib.Scene` and provide necessary tools for slides rendering.
+    Inherits from :class:`manim.scene.scene.Scene` or :class:`manimlib.scene.scene.Scene` and provide necessary tools for slides rendering.
    """

    def __init__(
@ -105,6 +105,11 @@ class Slide(Scene):  # type:ignore

    def add_last_slide(self) -> None:
        """Adds a 'last' slide to the end of slides."""
+
+        if self.current_animation == self.slides[-1].end_animation:
+            self.slides[-1].type = SlideType.last
+            return
+
        self.slides.append(
            SlideConfig(
                type=SlideType.last,
@ -224,9 +229,9 @@ class Slide(Scene):  # type:ignore

 class ThreeDSlide(Slide, ThreeDScene):  # type: ignore
    """
-    Inherits from `manim.ThreeDScene` or `manimlib.ThreeDScene` and provide necessary tools for slides rendering.
+    Inherits from :class:`Slide` and :class:`manim.scene.three_d_scene.ThreeDScene` or :class:`manimlib.scene.three_d_scene.ThreeDScene` and provide necessary tools for slides rendering.

-    Note that ManimGL does not need ThreeDScene for 3D rendering in recent versions, see `example.py`.
+    .. note:: ManimGL does not need ThreeDScene for 3D rendering in recent versions, see `example.py`.
    """

    pass
--- a/poetry.lock
+++ b/poetry.lock
--- a/pyproject.toml
+++ b/pyproject.toml
@ -1,56 +1,106 @@
+[build-system]
+build-backend = "poetry.core.masonry.api"
+requires = ["setuptools", "poetry-core>=1.0.0"]
+
+[tool.black]
+target-version = ["py38"]
+
+[tool.isort]
+profile = "black"
+py_version = 38
+
+[tool.mypy]
+check-untyped-defs = true
+# Disallow dynamic typing
+disallow-any-generics = true
+disallow-incomplete-defs = true
+disallow-subclassing-any = true
+# Disallow untyped definitions and calls
+disallow-untyped-defs = true
+ignore-missing-imports = true
+install-types = true
+# None and optional handling
+no-implicit-optional = true
+no-warn-return-any = true
+non-interactive = true
+python_version = "3.8"
+# Strict equality
+strict-equality = true
+warn-no-return = true
+warn-redundant-casts = true
+# Config file
+warn-unused-configs = true
+# Configuring warnings
+warn-unused-ignores = true
+
 [tool.poetry]
-name = "manim-slides"
-description = "Tool for live presentations using manim"
 authors = [
-    "Jérome Eertmans <jeertmans@icloud.com>"
+  "Jérome Eertmans <jeertmans@icloud.com>"
 ]
-version = "4.7.1"
-license = "GPL-3.0-only"
-readme = "README.md"
-homepage = "https://github.com/jeertmans/manim-slides"
-documentation = "https://eertmans.be/manim-slides"
-repository = "https://github.com/jeertmans/manim-slides"
-
-keywords = ["manim", "slides", "plugin", "manimgl"]
-
 classifiers = [
-        "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
-        "Programming Language :: Python :: 3.10",
-        "Programming Language :: Python :: 3.11",
-        "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
-        "Operating System :: OS Independent",
-        "Topic :: Multimedia :: Video",
-        "Topic :: Multimedia :: Graphics",
-        "Topic :: Scientific/Engineering",
-    ]
-
-exclude = ["docs/","static/"]
-packages = [
-    { include = "manim_slides" },
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+  "Operating System :: OS Independent",
+  "Topic :: Multimedia :: Video",
+  "Topic :: Multimedia :: Graphics",
+  "Topic :: Scientific/Engineering"
 ]
-
+description = "Tool for live presentations using manim"
+documentation = "https://eertmans.be/manim-slides"
+exclude = ["docs/", "static/"]
+homepage = "https://github.com/jeertmans/manim-slides"
+keywords = ["manim", "slides", "plugin", "manimgl"]
+license = "GPL-3.0-only"
+name = "manim-slides"
+packages = [
+  {include = "manim_slides"}
+]
+readme = "README.md"
+repository = "https://github.com/jeertmans/manim-slides"
+version = "4.8.2"

 [tool.poetry.dependencies]
-python = ">=3.8,<3.12"
-click = ">=8.0"
-click-default-group = ">=1.2"
-numpy = ">=1.19"
-opencv-python = ">=4.6"
-pydantic = ">=1.9"
-pyside6 = ">=6"
-requests = ">=2.26"
-tqdm = ">=4.62"
+click = "^8.1.3"
+click-default-group = "^1.2.2"
+numpy = "^1.19"
+opencv-python = "^4.6.0.66"
+pydantic = "^1.10.2"
+pyside6 = "^6.4.1"
+python = ">=3.8.1,<3.12"
+requests = "^2.28.1"
+tqdm = "^4.64.1"

-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
+black = "^22.10.0"
+isort = "^5.12.0"
+mypy = "^0.991"
+pre-commit = "^3.0.2"
+ruff = "^0.0.219"
+
+[tool.poetry.group.docs.dependencies]
+furo = "^2022.9.29"
+manim = "^0.17.0"
+myst-parser = "^0.18.1"
+sphinx = "^5.3.0"
+sphinx-click = "^4.4.0"
+sphinx-copybutton = "^0.5.1"
+sphinxext-opengraph = "^0.7.5"
+
+[tool.poetry.group.test.dependencies]
 manim = "^0.17.0"
 manimgl = "^1.6.1"

-[build-system]
-requires = ["setuptools","poetry-core>=1.0.0"]
-build-backend = "poetry.core.masonry.api"
-
 [tool.poetry.plugins]
+
 [tool.poetry.plugins."console_scripts"]
 manim-slides = "manim_slides.__main__:cli"
+
+[tool.ruff]
+ignore = [
+  "E501"
+]
+target-version = "py38"
--- a/static/docs.png
+++ b/static/docs.png
Author	SHA1	Message	Date
Jérome Eertmans	f15a3e9b59	chore(version): bump to 4.8.2	2023-01-31 10:41:55 +01:00
Jérome Eertmans	205972125c	chore(docs): improving the docs a bit more (#116 ) * chore(docs): improving the docs a bit more This adds some useful extensions, links, and add. information. * fix(deps): update lockfiles no-cache	2023-01-31 10:29:21 +01:00
Jérome Eertmans	e9d28dc0a8	feat(lib): remove constraint on last animation and update readme (#117 ) This removes the constraint that required a Slide class to end with a animation. This was actually not needed, and could lead to confusion since `self.wait` is not an animation with ManimGL, but well with Manim. This fix, however, still means that a calls to `self.wait` with ManimGL, after last `self.pause` call, will be ignored.	2023-01-31 10:07:59 +01:00
Jérome Eertmans	70b5ee39c3	chore(docs): fix missing image, app. order and link	2023-01-30 22:45:43 +01:00
Jérome Eertmans	616e025867	fix(ci): missing indent	2023-01-30 22:25:40 +01:00
Jérome Eertmans	0ce4c18519	chore(docs): improving the docs (#115 ) * chore(docs): improving the docs This improves the docs as suggested by some reddit user. Now, most of Manim is documented in one place * try: update lockfile * chore(deps): remove duplicate key * fix(ci): isort issue See https://github.com/home-assistant/core/issues/86892 * fix(ci): bad identation * fix(ci): fixing lock file * fix(example): issue when ManimGL does not count wait as animation	2023-01-30 22:23:53 +01:00
Jérome Eertmans	68ff5269eb	chore(ci): add yaml and toml formatters (#114 ) * chore(ci): add yaml and toml formatters * fix(ci): do not format poetry.lock * chore(lib): update poetry.lock	2023-01-30 19:11:58 +01:00
Jérome Eertmans	753f4e788b	chore(ci): improve docs build (#113 ) * chore(ci): improve docs build * fix(ci): trying to fix cache dir * chore(ci): split caching in two steps	2023-01-30 14:05:31 +01:00
Jérome Eertmans	f1f98bf241	fix(ci): build docs using poetry env (#112 )	2023-01-30 09:27:15 +01:00
pre-commit-ci[bot]	4b413c1528	[pre-commit.ci] pre-commit autoupdate (#110 ) updates: - [github.com/charliermarsh/ruff-pre-commit: v0.0.223 → v0.0.230](https://github.com/charliermarsh/ruff-pre-commit/compare/v0.0.223...v0.0.230) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>	2023-01-24 19:01:34 +01:00
pre-commit-ci[bot]	478e1d7d76	[pre-commit.ci] pre-commit autoupdate (#108 ) updates: - [github.com/charliermarsh/ruff-pre-commit: v0.0.219 → v0.0.223](https://github.com/charliermarsh/ruff-pre-commit/compare/v0.0.219...v0.0.223) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>	2023-01-17 07:02:23 +01:00
Jérome Eertmans	2b224530ab	chore(lint): remove flake8 in favor to ruff (#103 ) * chore(lint): apply suggested for flake8-black compat. This applies the changes suggested by the Black documentation. * from flake8 to ruff	2023-01-12 17:42:10 +01:00
Jérome Eertmans	cd7a054cf1	chore(version): bump to 4.8.1 (#102 )	2023-01-01 19:27:53 +01:00
yang-fighter	1ff2330ff2	fix(convert): correctly quote paths when using ffmpeg on Windows With the current version of ffmpeg on Windows, the list file must enclosed by single quotes.	2023-01-01 19:12:45 +01:00
pre-commit-ci[bot]	1e150bbb84	[pre-commit.ci] pre-commit autoupdate (#100 ) updates: - [github.com/pycqa/isort: v5.11.3 → 5.11.4](https://github.com/pycqa/isort/compare/v5.11.3...5.11.4) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>	2022-12-27 08:47:36 +01:00
pre-commit-ci[bot]	13f19649aa	[pre-commit.ci] pre-commit autoupdate (#99 ) updates: - [github.com/pycqa/isort: 5.11.0 → v5.11.3](https://github.com/pycqa/isort/compare/5.11.0...v5.11.3) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>	2022-12-20 11:09:07 +01:00
pre-commit-ci[bot]	4c97bdd3a3	[pre-commit.ci] pre-commit autoupdate (#97 ) updates: - [github.com/pycqa/isort: 5.10.1 → 5.11.0](https://github.com/pycqa/isort/compare/5.10.1...5.11.0) - [github.com/psf/black: 22.10.0 → 22.12.0](https://github.com/psf/black/compare/22.10.0...22.12.0) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>	2022-12-14 08:51:54 +01:00
Jérome Eertmans	777ff444a3	chore(cli): clean debug print	2022-12-09 09:48:36 +01:00
Jérome Eertmans	9cb1c35f00	chore(ci): move mypy config to pyproject.toml (#94 )	2022-12-08 11:53:56 +01:00
Jérome Eertmans	1fed193cb3	chore(ci): move black config to pyproject.toml (#93 ) * chore(ci): move black config to pyproject.toml * chore(deps): update target version	2022-12-08 11:34:20 +01:00
Jérome Eertmans	9f227936f7	chore(lib): add link for audio blocking	2022-12-08 11:19:47 +01:00
Jérome Eertmans	2fe6139d18	chore(ci): move isort config to pyproject.toml (#92 ) * chore(ci): move isort config to pyproject.toml * fix(ci): typo in config	2022-12-08 11:16:54 +01:00
Jérome Eertmans	54f2c60c4e	chore(deps): use carret version requirements (#91 )	2022-12-08 10:25:16 +01:00
Jérome Eertmans	9810425ff2	chore(version): update version	2022-12-07 17:19:19 +01:00
Jérome Eertmans	3dc543e3a6	chore(docs): update README and fix typo	2022-12-07 17:17:07 +01:00
Jérome Eertmans	c0c73ad4d4	feat(cli): feally featured RevealJS template (#80 ) * feat(cli): feally featured RevealJS template This adds an option for every possible RevealJS option. Error messages are also improved. RevealJS version is bumped to latest (4.4.0). * feat(cli): add primitive support for arbitrary JS functions * fix(cli): some typos / issues in template * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix(lib): pickling issue * fix(lib): ignore typing error due to __reduce_ex__ * feat(cli): add template selection, fixes first slide bug, and rm stuff Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>	2022-12-07 16:27:23 +01:00
Jérome Eertmans	a82ca81dc5	chore(deps): add dependency groups (#89 ) This uses poetry's dependency groups to be more rigorous about modules version.	2022-12-06 14:56:18 +01:00
Jérome Eertmans	a68a4e1517	feat(cli): speedup scaling with painter scaling (#88 ) As suggested by PySide6's documentation, we avoid using pixmap.scaled() on every frame, but use scaled content to resize the image. This seems to ignore ratio, explaining why we need a new option flag.	2022-12-06 12:06:35 +01:00