Highlightjs custom highlighting config ignored in production

[chenglou]

🐛 Bug Report

Have you read the Contributing Guidelines on issues?

Yes

To Reproduce

1. In siteConfig.js, in the highlight field, add this:

   hljs: function(hljs) {
     hljs.registerLanguage('reason', reasonHighlightJs)
   }

   where reasonHighlightJs is an existing callback that adds a new highlighter.
2. Run dev, see that the custom highlighting works

Expected behavior

Run prod, see that the custom highlighting should be picked up

Actual Behavior

Highlighting isn't picked up =(

Reproducible Demo

Check out reasonml/reasonml.github.io@2c7b36f then cd website && yarn && yarn start, compare some resulting highlighting html against yarn docusaurus-build in the generated docs folder.

Solution

This is caused by dev & prod not sharing the same code path. They have diverged quite a bit from what I'm seeing. I've patched this like so: chenglou@bade05e
As a matter of fact, siteConfig.hightlight.hlgs is never called anywhere in prod!
This patch works, but I'm not too sure this is the right way to go. The dev & prod flow should probably be much closer. There are likely other hidden bugs.

[endiliey]

As a matter of fact, siteConfig.hightlight.hljs is never called anywhere in prod!

As far as I'm aware, the only place where we define the highlightjs is only on that file. I checked the git blame and it seems that it has been like this since the initial release.

This patch works, but I'm not too sure this is the right way to go

I think the patch is the correct way to do it.

Thanks for reporting :)

[rishacha]

Hi, can I attempt this ?

[endiliey]

@rishacha sure, send a PR in 👍