feat: Add MDX rehypeSyntaxHighlight plugin options

[swwind]

What is it?

• Feature / enhancement
• Bug
• Docs / tests

Description

fixes QwikDev/qwik-evolution#86

Add plugin options for all 3 core plugins.

Use cases and why

// vite.config.mts

import fsharp from "refractor/lang/fsharp";

export default defineConfig(() => {
  return {
    plugins: [
      qwikCity({
        mdxPlugins: {
          remarkGfm: {
            singleTilde: false,
          },
          rehypeSyntaxHighlight: {
            setup(refractor) {
              refractor.register(fsharp)
            }
          },
          rehypeAutolinkHeadings: false,
        }
      })
    ]
  }

Checklist:

• My code follows the developer guidelines of this project
• I have performed a self-review of my own code
• I have made corresponding changes to the documentation
• Added new tests to cover the fix / functionality

[stackblitz]

Run & review this pull request in StackBlitz Codeflow.

[swwind]

This fix still contains a problem, types of refractor, remark-gfm and rehype-autolink-headings must be installed manually to have full functionality.

i.e. You must install remark-gfm manually to make remarkGfm option in mdxPlugins have type boolean | import('remark-gfm').Options, otherwise it will be any due to the bundle step doesn't bundle external types all together.

Despite this little problem, other functionalities just works fine.

[manucorporat]

It's a big problem, no? if we merge this, it will break everybody's project because of missing types

[swwind]

It's a big problem, no? if we merge this, it will break everybody's project because of missing types

@manucorporat I think it's possible to inline all the types to handle this problem, but I think the original solution requires more API design thinking.

The original issue wants to have setup function for configuring refractor, but qwik-city bundled every dependency into a single package, and user manually installed refractor package version may differ than our bundled version. Combining pieces of code from different versions of a package has a high potential for bugs and vulnerabilities.

[swwind]

It doesn't give sense to inline the types. And I have no idea how to deal with type declaration.

I'll suggest export rehype-syntax-highlight as an independent package and override configs using old styles.