You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Update Readme
* Bump version to 1.0.0 🌟
* Add video to Readme & footer
* Wrap showcase video in markdown link
* Add custom gallery banner color
* Improve some Readme sentences & add some words about a possible debugger
* Add another <br>
* Fix outdated link to marketplace
* Fix missing string
> December 2024 / January 2025: Hey there👋 We are currently working to ship the first release of Manim Notebook. The version already available on the VSCode Marketplace is outdated. If you are interested in the current state of the extension, just clone this repo and follow the [Developing guide](https://github.com/Manim-Notebook/manim-notebook/wiki/Developing).
20
+
<br>
21
21
22
22
> [!warning]
23
-
> This VSCode extension is specifically for [3b1b's original manim library](https://github.com/3b1b/manim)<br>
24
-
> and *NOT* the [Manim Community Edition (Manim CE)](https://www.manim.community/).
23
+
> This extension is for [3b1b's Manim library](https://github.com/3b1b/manim) and *NOT* the [Manim Community Edition (Manim CE)](https://www.manim.community/).
Manim Notebook is a VSCode extension that tailors your needs when writing Python code to animate mathematical concepts with 3Blue1Brown's [Manim library](https://github.com/3b1b/manim). It's *NOT* a Jupyter Notebook; instead it enriches your existing Python files with interactive Manim cells that let you live-preview parts of the code and instantly see the animations.
29
+
Manim Notebook is a VSCode extension tailored to your needs when writing Python code to animate mathematical concepts with 3Blue1Brown's [Manim library](https://github.com/3b1b/manim). It's *NOT* a Jupyter Notebook; instead it enriches your existing Python files with interactive Manim cells that let you live-preview parts of the code and instantly see the animations.
29
30
30
31
Originally, the motivation for this extension was Grant Sanderson's video [How I animate 3Blue1Brown](https://youtu.be/rbu7Zu5X1zI?feature=shared) where he shows his Manim workflow in Sublime Text. This extension brings a similar workflow to VSCode but even goes further and provides a rich VSCode integration.
31
32
32
33
## 💻 Usage
33
34
34
-
Our VSCode **walkthrough** will guide you through the first steps and provide a sample file. It should open automatically upon installation of [the Manim Notebook extension](https://marketplace.visualstudio.com/items?itemName=bhoov.vscode-manim). If not, you can invoke it manually: open the command palette (`Ctrl/Cmd + Shift + P`) and search for `Manim Notebook: Open Walkthrough`.
35
+
Our VSCode **walkthrough** will guide you through the first steps and provide a sample file. The walkthrough should open automatically upon installation of [the Manim Notebook extension](https://marketplace.visualstudio.com/items?itemName=Manim-Notebook.manim-notebook). If not, you can invoke it manually: open the command palette (`Ctrl/Cmd + Shift + P`) and search for `Manim Notebook: Open Walkthrough`.
35
36
36
37
The main concept is that of a Manim Cell, which is just a regular Python comment, but one that starts with `##` instead of `#`.
37
38
@@ -44,13 +45,22 @@ The main concept is that of a Manim Cell, which is just a regular Python comment
44
45
45
46
## 🚀 Features
46
47
47
-
-**Manim Cells**. Split your code into Manim Cells that start with `##`. You will be presented with a CodeLens to preview the animation.
48
-
-**Preview any code**. Simple as that, select any code and preview it.
48
+
-**Manim Cells**. Split your code into Manim Cells that start with `##`. You will be presented with a CodeLens to preview the animation (and you can even _reload_ your changed Python files such that you don't have to restart the preview).
49
+
-**Preview any code**. Simple as that, select any code and preview it. No manual copy-pasting needed.
49
50
-**With or without Terminal**. The extension parses the `manimgl` terminal output to provide rich VSCode integrations and makes possible an almost terminal-free workflow.
50
51
- Shows the progress of the live Manim preview as VSCode progress bar.
51
52
- Takes a user-defined delay into account, e.g. to wait for custom shell startup scripts (like `venv` activation).
52
53
- State management: keeps track of the ManimGL state to react accordingly in different situations, e.g. prevent from running multiple statements at the same time.
53
54
-**Video export**. Export your animations to a video file. A small wizard will guide you through the most important settings.
54
55
-**And more...** Find all commands in the command palette (`Ctrl/Cmd + Shift + P`) by searching for `> Manim Notebook`. E.g. another command lets you `clear()` the window. Yet with another one you can start the scene at your cursor.
55
56
56
-
TODO: Add a more complete feature list (maybe to the Wiki?). Add images to showcase each feature.
57
+
<sub>
58
+
In the long run, we aim to even provide a <strong>Debugger for Manim code</strong> such that you can step through your animations and run until breakpoints. This would be a huge step forward in the Manim development workflow. For now, the Manim Cells that we provide are a start towards a more interactive experience.
<imgsrc="https://github.com/user-attachments/assets/b13a01f6-7d24-4bfb-9d3f-fee7b8a456a3"alt="Manim Notebook Logo with a fancy color-gradient background"/>
0 commit comments