Allow custom HTML in `<head>`. #385

vizziv · 2020-09-11T00:05:40Z

Adds headHtml : Optional Text option to the configuration. It can be set in one of two ways, but not both simultaneously.

The option can be set as usual in ./neuron.dhall.
If the file ./head.html exists, then headHtml is set to Some [head.html's contents].

Addresses #362 directly. Also solves or enables workarounds for several other issues (e.g. #212, #361, #383).

Adds `headHtml : Optional Text` option to the configuration. It can be set in one of two ways, but not both simultaneously. - The option can be set as usual in `./neuron.dhall`. - If the file `./head.html` exists, then `headHtml` is set to its `Some [head.html's contents]`.

srid · 2020-09-11T00:44:48Z

@vizziv Thanks! Taking a quick look at the diff, I see that this differs from #362 in two ways:

Why the neuron.dhall configuration, over just using head.html if it exists (see convention over configuration)?
Why is the default mathjax script still included? I thought we would have a default snippet for head.html when it is not specified by the user, and that this snippet would contain the existing mathjax include. The idea being that if the user overrides head.html, they become responsible for including whatever math script (math or katex or whatever) they need.

vizziv · 2020-09-11T02:28:11Z

The answer in both cases is that I chose a solution that made the fewest changes to the code, as I wanted to submit the minimally invasive patch that added the feature. But I'm happy to make both changes.

Regarding how to organize the code for the first change: should we use the Config type to store head.html's contents, or should we create a new module and type to handle it? (Or should we just put the code reading head.html directly into Main?)

vizziv · 2020-09-11T02:37:59Z

Another question about the second change: right now we replace $/$ pairs with $/$ pairs for MathJax's sake. Should disabling MathJax entail disabling this replacement?

srid · 2020-09-11T02:38:32Z

Checkout how the icon and manifest files are handled for inspiration. They are loaded in src/app/Main.hs as manifest and passed around (along with config) as a function argument to renderRoutePage. You can do the same for head.html. And notice how Neuron.Web.Manifest handles the creation of the manifest type, including handing the default case - of using neuron logo as the favicon.

srid · 2020-09-11T02:43:25Z

re: MathJax - I'm not sure what you mean; neuron doesn't do any special processing, aside from letting commonmark handle it (see CE.mathSpec in Neuron.Reader.Markdown). The mathJaxSupport config field should be ... made to be totally ignored in this PR (with a deprecation warning), and entirely removed one day, I think.

srid · 2020-09-11T02:45:00Z

You can probably sneak in the head.html stuff in a new field of the Neuron.Web.Manifest:Manifest type, while renaming that module/type suitably (it won't just be a "manifest" anymore).

vizziv · 2020-09-11T03:12:36Z

Ahh, I'd already made a new module for this, creatively named HeadHtml. But it could definitely be easily combined with (an appropriately renamed) Manifest either now or in the future.

vizziv · 2020-09-11T04:37:49Z

The mathJaxSupport config field should be ... made to be totally ignored in this PR (with a deprecation warning), and entirely removed one day, I think.

I've removed mathJaxSupport from Config. I wasn't sure how to best add a deprecation warning, so instead we throw an error. This also throws an error for other spurious fields in neuron.dhall.

I'm not sure how you want to update the guide to reflect these changes, so I'll leave that to you and others if that's okay.

re: MathJax - I'm not sure what you mean; neuron doesn't do any special processing, aside from letting commonmark handle it (see CE.mathSpec in Neuron.Reader.Markdown).

Yeah, looks like the $/$-to-$/$ conversion is determined by some combination of commonmark-pandoc and pandoc. Will table this for now.

neuron/src/app/Main.hs

neuron/src/app/Neuron/Config.hs

neuron/src/app/Neuron/Web/View.hs

neuron/src/lib/Neuron/Config/Type.hs

srid · 2020-09-11T18:20:40Z

About the deprecation warning .. okay, let's not worry about it; let's ignore the mathjax field silently if used by the user. I added some comments in your PR.

About the $ -> ( conversion, that happens here: https://github.com/srid/reflex-dom-pandoc/blob/259c7a881dd4ba69f82ac2fdec83ddf8f5ee0fc5/src/Reflex/Dom/Pandoc/Document.hs#L204

srid

@vizziv You know what, I'm now not sure if it is so important to support backwards compact, especially if it makes config parsing rather complex.

Most users I imagine won't have mathJaxSupport = false in their config. Those that do, can always remove it when next updating neuron.

So let's get rid of the config fields check entirely. Please undo the Config changes in your PR, except for removing mathJaxSupport field entirely from the Config type.

neuron/src/app/Neuron/Config.hs

neuron/src/app/Neuron/Web/View.hs

vizziv · 2020-09-13T02:11:16Z

Okay, I undid the config changes (except I removed the mathJaxSupport field) and explained DOCTYPE.

The Neuron.Config and Neuron.Config.Type commit histories on this branch are now kind of messy, so squashing these commits upon merging makes sense.

srid added the case-for-themes label Sep 11, 2020

Separate head.html from Config code.

162a165

vizziv added 2 commits September 10, 2020 23:42

Remove mathJaxSupport configuration option.

8e6a5db

Throw an error if there are spurious fields in neuron.dhall.

4ce2f28

srid requested changes Sep 11, 2020

View reviewed changes

vizziv added 2 commits September 12, 2020 00:59

Simplify HeadHtml interface.

2c573f6

Clean up Config interface.

b252ac1

vizziv requested a review from srid September 12, 2020 05:27

srid requested changes Sep 12, 2020

View reviewed changes

neuron/src/app/Neuron/Config.hs Outdated Show resolved Hide resolved

neuron/src/app/Neuron/Web/View.hs Outdated Show resolved Hide resolved

vizziv added 2 commits September 12, 2020 22:01

Remove changes to Config, except remove mathJaxSupport field.

332b9f6

Add comment explaining DOCTYPE declaration.

bd231c7

srid approved these changes Sep 13, 2020

View reviewed changes

srid changed the base branch from master to dev September 13, 2020 19:34

srid merged commit 8d61054 into srid:dev Sep 13, 2020

This was referenced Sep 13, 2020

Dark mode #391

Closed

Allow custom <head> #362

Closed

Switch to KaTeX #212

Closed

[Feature Request] Inserting custom HTML into static web site generation #383

Closed

vizziv deleted the custom-head branch September 13, 2020 21:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow custom HTML in `<head>`. #385

Allow custom HTML in `<head>`. #385

vizziv commented Sep 11, 2020 •

edited

Loading

srid commented Sep 11, 2020

vizziv commented Sep 11, 2020

vizziv commented Sep 11, 2020

srid commented Sep 11, 2020

srid commented Sep 11, 2020

srid commented Sep 11, 2020

vizziv commented Sep 11, 2020

vizziv commented Sep 11, 2020

srid commented Sep 11, 2020 •

edited

Loading

srid left a comment

vizziv commented Sep 13, 2020

Allow custom HTML in <head>. #385

Allow custom HTML in <head>. #385

Conversation

vizziv commented Sep 11, 2020 • edited Loading

srid commented Sep 11, 2020

vizziv commented Sep 11, 2020

vizziv commented Sep 11, 2020

srid commented Sep 11, 2020

srid commented Sep 11, 2020

srid commented Sep 11, 2020

vizziv commented Sep 11, 2020

vizziv commented Sep 11, 2020

srid commented Sep 11, 2020 • edited Loading

srid left a comment

Choose a reason for hiding this comment

vizziv commented Sep 13, 2020

Allow custom HTML in `<head>`. #385

Allow custom HTML in `<head>`. #385

vizziv commented Sep 11, 2020 •

edited

Loading

srid commented Sep 11, 2020 •

edited

Loading