Add configuration passthrough for remark-rehype

[marcus-crane]

Description

This change adds the ability to pass configuration from _config.ts down to remark-rehype.

It can be useful for users who need to customise how footnotes are rendered for Markdown files (such as when using Littlefoot as well as a few other things should they be needed.

Related Issues

Implements #517

Check List

• Have you read the
  CODE OF CONDUCT
• Have you read the document
  CONTRIBUTING
  • One pull request per feature. If you want to do more than one thing,
    send multiple pull request.
  • Write tests.
  • Run deno fmt to fix the code format before commit.
  • Document any change in the CHANGELOG.md.

[marcus-crane]

While there are no tests included, I'll note that I've run through a bunch of manual tests with my own site against the latest master branch.

Overwriting the defaults work as expected (Dangerous HTML renders by default but can be stubbed out if the user chooses) as well as extra options like footnote overrides working.

Probably some tests could be written but I figure if there are none for Remark already, why start now 😉

On a side note, I think there is probably value in exporting remark types through to _config.ts as currently Options just takes untyped arrays and objects so it's not clear from your site config what options are possible. That's a story for another time though.

[oscarotero]

I'd change this option to remarkOptions object for consistency with rehypePlugins and to make clear that it contains the options for rehype, not the remarkRehype option itself.

[marcus-crane]

Ah ok, I wasn't quite clear on whether remark-rehype was still technically a remark plugin or if it was a standalone thing of sorts but yeah, that makes more sense

[oscarotero]

Hi @marcus-crane
Thanks for this. Just a couple of comments:

• Your PR is targeted to main which is for Lume 2. If you want to make these changes in Lume 1, it should be changed to v1 branch.
• There are already tests for remark (https://github.com/lumeland/lume/blob/v1/tests/remark.test.ts#L10).

[marcus-crane]

Ah! That explains a lot re: main being v2 oops. I'll fix that up 🙂

[marcus-crane]

Closing this until I open a proper PR from the v1 branch