Document how to create a slideshow in the README (#100)

* Document how to make a slideshow * docs: store images locally in `docs` folder
jupyterlab-contrib · Dec 30, 2024 · 3518b57 · 3518b57
1 parent 83c0804
commit 3518b57
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -36,6 +36,15 @@ To remove the extension, execute:
 pip uninstall jupyterlab_rise
 ```
 
+## Usage
+To mark a cell as a new slide, sub-slide or fragment, open the property inspector and choose the slide type:
+
+<img src="./docs/prop-inspector-slide-type.png" alt="Property inspector slide type" style="width:100%; height:auto;">
+
+Use `Ctrl+R` to render the current notebook as a slidehow:
+
+<img src="./docs/render-slideshow.png" alt="Rendered slideshow" style="width:100%; height:auto;">
+
 ## Troubleshoot
 
 If you are seeing the frontend extension, but it is not working, check

diff --git a/docs/prop-inspector-slide-type.png b/docs/prop-inspector-slide-type.png
diff --git a/docs/render-slideshow.png b/docs/render-slideshow.png