chore(ci): checking links and spell checking (#417)

* chore(ci): checking links and spell checking

* chore(ci): move markdown-link-check to GitHub ci

Because pre-commit.ci does not have access to the internet...

* fix(lib): revert `reverse-...` utils because of warnings

* chore(ci): checking links and spell checking

* chore(ci): move markdown-link-check to GitHub ci

Because pre-commit.ci does not have access to the internet...

* fix(docs): myst-parser xref cannot end with .html

* fix(docs): oops

docs/source/_static/template.html

@@ -261,7 +261,7 @@
         mouseWheel: {{ mouse_wheel }},
 
         // Opens links in an iframe preview overlay
-        // Add `data-preview-link` and `data-preview-link="false"` to customise each link
+        // Add `data-preview-link` and `data-preview-link="false"` to customize each link
         // individually
         previewLinks: {{ preview_links }},
 

docs/source/contributing/index.md

@@ -18,10 +18,10 @@ workflow
 internals
 ```
 
-[Workflow](./workflow)
+[Workflow](/contributing/workflow)
 : how to work on this project. Start here if you're a new contributor.
 
-[Internals](./internals)
+[Internals](/contributing/internals)
 : how Manim Slides is built and how the various parts of it work.
 
 ## Reporting an Issue

docs/source/contributing/workflow.md

@@ -18,7 +18,9 @@ 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.
+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.
@@ -36,7 +38,7 @@ pdm install
 This, however, only installs the minimal set of dependencies to run the package.
 
 If you would like to install Manim or ManimGL,
-as documented in the [quickstart](../quickstart),
+as documented in the [quickstart](/quickstart),
 you can use the `-G|--group` option:
 
 ```bash
@@ -45,7 +47,7 @@ pdm install -Gmanim   # For Manim
 pdm install -Gmanimgl # For ManimGL
 ```
 
-Additionnally, Manim Slides comes with groups of dependencies for development purposes:
+Additionally, Manim Slides comes with groups of dependencies for development purposes:
 
 ```bash
 pdm install -Gdev  # For linters and formatters

docs/source/index.md

@@ -23,7 +23,7 @@ og:description: Manim Slides makes creating slides with Manim super easy!
 
 Manim Slides makes creating slides with Manim super easy!
 
-In a [very few steps](./quickstart),
+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

docs/source/installation.md

@@ -12,7 +12,7 @@ The benefit of using pipx is that it will automatically create a new virtual
 environment for every package you install.
 
 :::{note}
-Everytime you read `pipx install`, you can use `pip install` instead,
+Every time you read `pipx install`, you can use `pip install` instead,
 if you are working in a virtual environment or else.
 :::
 
@@ -146,23 +146,26 @@ If you are using Nix or NixOS, you can find Manim Slides under:
    any Qt bindings.
 
 You can try out the Manim Slides package with
+
 ```sh
 nix-shell -p manim ffmpeg manim-slides
 ```
+
 or by adding it to your
 [configuration file](https://nixos.org/manual/nixos/stable/#sec-package-management).
 
 Alternatively, you can try Manim Slides in a Python environment with:
+
 ```sh
 nix-shell -p manim ffmpeg "python3.withPackages(ps: with ps; [ manim-slides, ...])"
 ```
+
 or bundle this into [your Nix environment](https://wiki.nixos.org/wiki/Python).
 
 :::{note}
 Nix current does not support `manimgl`.
 :::
 
-
 ## When you need a Qt backend
 
 Before `v5.1`, Manim Slides automatically included PySide6 as
@@ -182,5 +185,5 @@ install those are via optional dependencies, as explained above.
 
 An alternative way to install Manim Slides is to clone the git repository,
 and build the package from source. Read the
-[contributing guide](./contributing/workflow)
+[contributing guide](/contributing/workflow)
 to know how to process.

docs/source/quickstart.md

@@ -1,7 +1,7 @@
 # Quickstart
 
 If not already, install Manim Slides, along with either Manim or ManimGL,
-see [installation](./installation).
+see [installation](/installation).
 
 ## Creating your first slides
 
@@ -31,4 +31,5 @@ The output slides should look this this:
     :quality: high
 ```
 
-For more advanced examples, see the [Examples](reference/examples) section.
+For more advanced examples,
+see the [Examples](/reference/examples) section.

docs/source/reference/gui.md

@@ -2,7 +2,8 @@
 
 Manim Slides' graphical user interface (GUI) is the *de facto* way to present slides.
 
-If you do not specify one of the commands listed in the [CLI reference](./cli),
+If you do not specify one of the commands listed in the
+[CLI reference](/reference/cli),
 Manim Slides will use **present** by default, which launches a GUI window,
 playing your scene(s) like so:
 
@@ -25,7 +26,7 @@ directory, you should not worry about that :-)
 ## Configuration File
 
 It is possible to configure Manim Slides via a configuration file, even though
-this feature is currently limited. You may initiliaze the default configuration
+this feature is currently limited. You may initialize the default configuration
 file with:
 
 ```bash

docs/source/reference/html.md

@@ -30,11 +30,11 @@ manim-slides convert --show-config
 ## Using a Custom Template
 
 The default template used for HTML conversion can be found on
-[GitHub](https://github.com/jeertmans/manim-slides/blob/main/manim_slides/data/revealjs_template.html)
+[GitHub](https://github.com/jeertmans/manim-slides/blob/main/manim_slides/templates/revealjs.html)
 or printed with the `--show-template` option.
 If you wish to use another template, you can do so with the
 `--use-template FILE` option.
 
 ## More about HTML Slides
 
-You can read more about HTML slides in the [sharing](./sharing) section.
+You can read more about HTML slides in the [sharing](/reference/sharing) section.

docs/source/reference/index.md

@@ -16,23 +16,23 @@ sharing
 Sphinx Extension <sphinx_extension>
 ```
 
-[Application Programming Interface](./api): list of classes and methods that may
+[Application Programming Interface](/reference/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
+[Command Line Interface](/reference/cli): list of all commands available using Manim
 Slides' executable.
 
-[Examples](./examples): curated list of examples and their output.
+[Examples](/reference/examples): curated list of examples and their output.
 
-[Graphical User Interface](./gui): details about the main Manim Slide' feature.
+[Graphical User Interface](/reference/gui): details about the main Manim Slide' feature.
 
-[HTML Presentation](./html): an alternative way of presenting your animations.
+[HTML Presentation](/reference/html): an alternative way of presenting your animations.
 
-[IPython Magic](./ipython_magic): a magic to render and display Manim Slides inside notebooks.
+[IPython Magic](/reference/ipython_magic): a magic to render and display Manim Slides inside notebooks.
 
-+ [Example](./magic_example): example notebook using the magics.
++ [Example](/reference/magic_example): example notebook using the magics.
 
-[Sharing](./sharing): how to share your presentation with others.
+[Sharing](/reference/sharing): how to share your presentation with others.
 
 
-[Sphinx Extension](./sphinx_extension): a Sphinx extension for diplaying Manim Slides animations within your documentation.
+[Sphinx Extension](/reference/sphinx_extension): a Sphinx extension for displaying Manim Slides animations within your documentation.

docs/source/reference/sharing.md

@@ -126,10 +126,15 @@ to use an `iframe`:
 </div>
 ```
 
+<!-- markdown-link-check-disable -->
+<!-- see why: https://github.com/tcort/markdown-link-check/discussions/189 -->
+
 The additional code comes from
 [this article](https://faq.dailymotion.com/hc/en-us/articles/360022841393-How-to-preserve-the-player-aspect-ratio-on-a-responsive-page)
 and it there to preserve the original aspect ratio (16:9).
 
+<!-- markdown-link-check-enable -->
+
 ### Sharing ONE HTML file
 
 If you set the `data_uri` option to `true` (with `-cdata_uri=true`),
@@ -142,8 +147,8 @@ HTML conversion makes it convenient to play your presentation on a
 remote server.
 
 This is how your are able to watch all the examples on this website. If you want
-to know how to share your slide with GitHub pages, see the
-[workflow file](https://github.com/jeertmans/manim-slides/blob/main/.github/workflows/pages.yml).
+to know how to share your slide with GitHub pages, check out the
+[Manim Slides Starter GitHub repository template](https://github.com/jeertmans/manim-slides-starter).
 
 :::{warning}
 Keep in mind that playing large video files over the internet network