Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how to create a slideshow in the README #100

Merged
merged 2 commits into from
Dec 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Binary file added docs/prop-inspector-slide-type.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/render-slideshow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading