Skip to content

Commit cfdf2b0

Browse files
authored
Continuous Release 1.0.0 (#128)
* 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
1 parent 6018541 commit cfdf2b0

File tree

3 files changed

+29
-15
lines changed

3 files changed

+29
-15
lines changed

.github/workflows/publish.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ jobs:
2121
- name: Package extension
2222
run: npm run package-vsce
2323

24-
- name: Upload VSIX artifact to
24+
- name: Upload VSIX artifact to GitHub Release notes
2525
if: startsWith(github.ref, 'refs/tags/')
2626
uses: actions/upload-artifact@v4
2727
with:

README.md

+22-12
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div align="center">
2-
<a href="https://marketplace.visualstudio.com/items?itemName=bhoov.vscode-manim">
2+
<a href="https://marketplace.visualstudio.com/items?itemName=Manim-Notebook.manim-notebook">
33
<img src="./assets/manim-notebook-logo.png" width="130px" alt="Manim Notebook Logo showing a physical notebook with an 'M' letter on its title page"/>
44
</a>
55

@@ -11,27 +11,28 @@
1111
</div>
1212

1313
<div align="center">
14-
<a href="https://marketplace.visualstudio.com/items?itemName=bhoov.vscode-manim">VSCode Marketplace (outdated)</a>
15-
| <a href="https://github.com/Manim-Notebook/manim-notebook/">GitHub</a>
14+
<a href="https://marketplace.visualstudio.com/items?itemName=Manim-Notebook.manim-notebook">VSCode Marketplace</a>
15+
|
16+
<a href="https://github.com/Manim-Notebook/manim-notebook/">GitHub</a>
1617
</div>
1718
</div>
1819

19-
> [!note]
20-
> 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>
2121

2222
> [!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/).
24+
25+
[**Manim Notebook Quick Showcase Video**](https://github.com/user-attachments/assets/24eab702-e351-4cc9-8f7b-7b94c54b4072)
2526

2627
## 🎈 What is this?
2728

28-
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.
2930

3031
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.
3132

3233
## 💻 Usage
3334

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`.
3536

3637
The main concept is that of a Manim Cell, which is just a regular Python comment, but one that starts with `##` instead of `#`.
3738

@@ -44,13 +45,22 @@ The main concept is that of a Manim Cell, which is just a regular Python comment
4445

4546
## 🚀 Features
4647

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.
4950
- **With or without Terminal**. The extension parses the `manimgl` terminal output to provide rich VSCode integrations and makes possible an almost terminal-free workflow.
5051
- Shows the progress of the live Manim preview as VSCode progress bar.
5152
- Takes a user-defined delay into account, e.g. to wait for custom shell startup scripts (like `venv` activation).
5253
- 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.
5354
- **Video export**. Export your animations to a video file. A small wizard will guide you through the most important settings.
5455
- **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.
5556

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.
59+
</sub>
60+
61+
<br>
62+
<br>
63+
64+
<a href="https://marketplace.visualstudio.com/items?itemName=Manim-Notebook.manim-notebook">
65+
<img src="https://github.com/user-attachments/assets/b13a01f6-7d24-4bfb-9d3f-fee7b8a456a3" alt="Manim Notebook Logo with a fancy color-gradient background"/>
66+
</a>

package.json

+6-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "manim-notebook",
33
"displayName": "Manim Notebook",
44
"description": "ManimGL with interactive previewing to easily visualize and share the beauty of mathematics and related fields.",
5-
"version": "0.0.4",
5+
"version": "1.0.0",
66
"publisher": "Manim-Notebook",
77
"author": {
88
"name": "Manim Notebook Contributors"
@@ -293,5 +293,9 @@
293293
"type": "git",
294294
"url": "https://github.com/Manim-Notebook/manim-notebook.git"
295295
},
296-
"icon": "assets/manim-notebook-logo.png"
296+
"icon": "assets/manim-notebook-logo.png",
297+
"galleryBanner": {
298+
"color": "#112039",
299+
"theme": "dark"
300+
}
297301
}

0 commit comments

Comments
 (0)