Skip to content

Add more RISE config options to SlidesExporter#2147

Open
lkeegan wants to merge 1 commit intojupyter:mainfrom
lkeegan:add_rise_overlay_header_footer_backimage_config_options
Open

Add more RISE config options to SlidesExporter#2147
lkeegan wants to merge 1 commit intojupyter:mainfrom
lkeegan:add_rise_overlay_header_footer_backimage_config_options

Conversation

@lkeegan
Copy link
Contributor

@lkeegan lkeegan commented May 7, 2024

  • reveal_overlay
  • reveal_header
  • reveal_backimage
  • reveal_footer

These options are documented here: https://rise.readthedocs.io/en/latest/customize.html#decorating-all-slides
Styling and ids of these elements follow RISE: https://github.com/damianavila/RISE/blob/master/classic/rise/static/main.js#L446-L470

Also update the reveal config options using the reveal dict in the notebook metadata if provided.

- reveal_overlay
- reveal_header
- reveal_backimage
- reveal_footer

These options are documented here: https://rise.readthedocs.io/en/latest/customize.html#decorating-all-slides
Styling and ids of these elements follow RISE: https://github.com/damianavila/RISE/blob/master/classic/rise/static/main.js#L446-L470

Also update the reveal config options using the reveal dict in the notebook metadata if provided.
@lkeegan lkeegan force-pushed the add_rise_overlay_header_footer_backimage_config_options branch from 24fb9ad to f1db586 Compare May 7, 2024 12:18
@lkeegan
Copy link
Contributor Author

lkeegan commented May 7, 2024

Example of use:

jupyter nbconvert tests/files/notebook1.ipynb --to slides --execute --SlidesExporter.reveal_header="Here is the header" --SlidesExporter.reveal_backimage="https://images.pexels.com/photos/255379/pexels-photo-255379.jpeg" --SlidesExporter.reveal_footer="Here is the footer"

image

@bouzidanas
Copy link
Contributor

Also update the reveal config options using the reveal dict in the notebook metadata if provided.

I happened across this PR after submitting my own that does the above. I checked your code and I think you are missing logic that copies the metadata options into the reveal initialization function. Otherwise, anything that isn't already configurable (command line and config file) wont be added.

My related PR: #2257

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants