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

Clarify that reveal.js 3.x is needed #735

Closed
wants to merge 3 commits into from

Conversation

takluyver
Copy link
Member

Closes gh-702

@damianavila
Copy link
Member

damianavila commented Jan 15, 2018

+1 as I said in the issue.

@mpacer
Copy link
Member

mpacer commented Jan 18, 2018

Looks good but I still think that the default of using the cdn (#732) is a better default for most people… unless we want to explicitly help people download an up-to-date version of reveal.js. My intuition is that we should provide that utility with something like a --standalone flag that downloads the version of reveal that we get from the cdn at runtime (or something that checks if it’s already present and only downloads it if it’s not present). Lots of people who are capable of using the CLI but aren’t familiar with js will run into issues around this otherwise (e.g., it’s unusual to have a directory with a js extension if you haven’t seen it before; that’s not the only reason but it’s emblematic).

@mpacer
Copy link
Member

mpacer commented Jan 18, 2018

Actually can you add a reference to the latest example of reveal.js that works? Also a test to make sure that the version mentioned in the docs works? That way, we’ll know if it ever breaks with the a nbconvert change?

@takluyver
Copy link
Member Author

I've added a note to the docs showing how to get reveal 3.6. Adding a test that reveal.js works would be a big job, however - it involves executing Javascript in a browser, which the nbconvert tests are not set up to do. And we know from the notebook tests what a pain it is.


git clone https://github.com/hakimel/reveal.js.git
cd reveal.js
git checkout 3.6.0
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are using reveal.js 3.5.0 in the serve post-processor, we should keep it consistent and checkout 3.5.0 until we decide to upgrade the whole thing to 3.6.0, I think.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Damian, updated.

@mpacer
Copy link
Member

mpacer commented Jan 26, 2018

Closing since we now have #732 merged with this inside of it.

@mpacer mpacer closed this Jan 26, 2018
@mpacer mpacer removed this from the 5.4 milestone Sep 4, 2018
@MSeal MSeal added this to the no action milestone Sep 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Locally hosted reveal.js leads to blank page when serving without --post
4 participants