reveal-hugo icon indicating copy to clipboard operation
reveal-hugo copied to clipboard

Dependency updates (Reveal.js and marked.js)

Open chrisreddington opened this issue 3 years ago • 7 comments

This is a work in progress Pull Request, please do not yet merge.

Changes made

  • [X] Upgraded reveal.js to 4.2.1.

    • [X] Removed PrintCSS from
    • [x] Plugin Registration
    • [X] Removed the multiplex folder
  • [X] Upgraded marked.js to 4.0.12

Observations -

  • Several directory paths changed as part of the upgrade to 4.2.1 as per the upgrade documentation from reveal.js. I have tried to reflect the same structure in the appropriate folders in the reveal-hugo theme (e.g. /static/reveal-js/dist... etc.) This should make it easier to maintain for further minor/patch updates (rather than having to map back to older versions of the reveal-js directory structure).

Support needed

  • I am familiar with hugo, but new to Reveal.js and have not yet made a presentation. The default presentations in exampleSite seem to work from what I can see. It would be useful if others could test this out in a dev environment with some more advanced presentations before merging.

Out of scope -

A lot of the reveal-js docs seem to base their dependencies upon NPM, whereas they are static files here. Changing to that structure felt beyond the scope of this PR, so I have tried to update any external dependencies manually where it makes sense (e.g. marked.js). This may be something to consider as part of a wider project strategy/direction?

chrisreddington avatar Feb 24 '22 20:02 chrisreddington

Hi @dzello - I have now fixed the 'breaking change' for plugin registration from V 3.x to V4.x of reveal.JS. However, I've currently just put a very simple line in, referencing those on line 42-44 of partials/layout/javascript.html.

Would appreciate your input on how you envisage this working, in combination with plugins being defined by users.

chrisreddington avatar Feb 25 '22 16:02 chrisreddington

@chrisreddington Thanks for the PR, this is really great. I'll set aside a few minutes this week to answer the questions and give input.

My nose has been out of the code for a while, curious to know if we think there is any interaction between this PR and #114 from @deining?

joshed-io avatar Feb 28 '22 08:02 joshed-io

Thanks @dzello! From what I can see, there is no interaction/overlap with #114 from @deining. In fact, I think they could compliment each other quite nicely.

The idea of #114 is to make your theme a Hugo Module, which could give users another option/route to import the theme into their Hugo site. Whereas this PR is more focused on upgrading the dependencies of the theme, so would be a good enhancement regardless of how a user chooses to adopt the theme :)

This PR does supersede #91 though, as the latest Reveal.js is now 4.2.1 (whereas that one was targeted at 4.0.2).

Hope it helps!

chrisreddington avatar Feb 28 '22 19:02 chrisreddington

Hi @dzello, just wanted to check in and see if you had any thoughts on this? Thank you!

chrisreddington avatar Mar 07 '22 10:03 chrisreddington

Hi @dzello, just wanted to check in again and see if you had thoughts on proceeding on this one? Would love to make this a contribution into your project :) Thanks!

chrisreddington avatar Mar 30 '22 09:03 chrisreddington

Thank you this really helped me a lot. I was wondering why r-stack wasn't working but with this pull-request it worked :)

zoop-btc avatar Aug 07 '22 19:08 zoop-btc

Hi @dzello, just wanted to check in again and see if you had thoughts on proceeding on this one? Would love to make this a contribution into your project :) Thanks!

Me, too!

ccamara avatar Sep 01 '22 19:09 ccamara

I tested this locally and everything seems to work. I am not sure why there are duplicates of themes in assets/reveal-js/dist/theme and static/reveal-js/dist/theme and static/reveal-js/css/theme can we have only one ?

davidovich avatar Nov 14 '22 03:11 davidovich

Any chance to get this PR merged eventually? I would love to see this contribution landed.

deining avatar Jan 10 '23 09:01 deining

Hello @chrisreddington, and happy new year!

Do you mind if I pursue this PR further ?

Now that we have a mechanism for specifying plugin configuration, I believe we can address the questions of naming plugins that you raised. I would also look into the duplicated files.

davidovich avatar Jan 10 '23 16:01 davidovich