journalovi / jovi-template-quarto

JoVI experimental track article template written in Quarto
http://www.journalovi.org/jovi-template-quarto/
2 stars 8 forks source link

Do we want HTML files to be self-contained? #7

Open mjskay opened 1 year ago

mjskay commented 1 year ago

See here: https://quarto.org/docs/output-formats/html-publishing.html#standalone-html

The advantage of the files being self-contained is that they're easier to share, and probably also easier to archive (they won't depend on external JavaScript, for example --- thus less likely to break). The disadvantage is the output files are less human-readable (maybe not a huge issue given the review is more apt to be done on the qmd file) and the files are larger.

So, some questions:

My initial thought is: for the final version, we should probably embed everything (including math libraries) to ensure papers are easier to share and more likely to stay working long term. For review, I'm not sure we need/want to do this, as I have not (so far) had issues viewing the HTML versions of papers if they are committed to the repo using (e.g.) the github html preview service (https://htmlpreview.github.io/).