Skip to content

Commit

Permalink
fixed links to example
Browse files Browse the repository at this point in the history
  • Loading branch information
christopher-besch committed Oct 30, 2021
1 parent cce7dd2 commit e9c7e13
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The ``Manim Editor`` offers two main functions:

.. tip::

If you want to test the ``Manim Editor`` without having to install anything, take a look at the `example <https://manimeditorproject.github.io/manim_editor/tutorial/>`_.
If you want to test the ``Manim Editor`` without having to install anything, take a look at the `example <https://manimeditorproject.github.io/manim_editor/>`_.

If you don't know how to use ``Manim``, `it's documentation <https://docs.manim.community/en/stable>`_ is where you should start.
Come back once you've familiarised yourself with the core concepts.
Expand Down
11 changes: 10 additions & 1 deletion docs/source/internals.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,13 @@ Build from Source
* enter poetry shell: ``poetry shell``
* install npm modules: ``npm ci``
* compile web files: ``npm run build_debug` or `npm run build_release``
* start editor: ``manedit``
* start editor in debug mode: ``manedit --debug``


History
*******

This project started in September 2021 as the `Manim Web Presenter <https://github.com/christopher-besch/manim_web_presenter>`_, which has been inspired by the `Manim Presentation Repo <https://github.com/galatolofederico/manim-presentation>`_.
Back then Manim didn't have any sections, therefore this functionality had to be implemented using wrappers around the ``Scene`` class and subclasses.
This was an ugly solution, which turned obsolete with the `implementation of the Section API <https://github.com/ManimCommunity/manim/pull/2152>`_
Since more and more features were requested, it made sense to re-design the project from scratch and give it another name: the ``Manim Editor``.
4 changes: 2 additions & 2 deletions docs/source/use.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The first thing you have to take care of is your ``Manim`` scene.
What you have to take care of is the type of each section.
The ``Manim Editor`` defines four types, which can be imported using ``from manim_editor import PresentationSectionType``.

These types are explained in the `interactive tutorial <https://manimeditorproject.github.io/manim_editor/tutorial/>`_.
These types are explained in the `interactive tutorial <https://manimeditorproject.github.io/manim_editor/>`_.

.. table:: Types defined by the ``Manim Editor``

Expand Down Expand Up @@ -81,4 +81,4 @@ Simply run this in the projects directory:
Instead of running a local web server you can host the project on an online web server (e.g. GitHub Pages).
That way you can access it from anywhere.
This is how the `example <https://manimeditorproject.github.io/manim_editor/tutorial/>`_ has been created.
This is how the `example <https://manimeditorproject.github.io/manim_editor/>`_ has been created.

0 comments on commit e9c7e13

Please sign in to comment.