Docs unclear on adding remark plugins(?)

[Zenahr]

Usually, adding remark plugins is easy. I'm having trouble with adding this plugin however: https://github.com/wataru-chocola/remark-extended-table/tree/main/packages/remark-extended-table#remark-extended-table

I tried:

1. yarn add remark-extended-table
2. Adding the plugin to remarkPlugins in docusaurus config:

async function createConfig() {
  const remarkExtendedTable = (await import('remark-extended-table')).default;
  
 ...
 
         remarkPlugins: [
          [remarkExtendedTable, {'colspanWithEmptyCell': true}],
        ]
...

This doesn't do anything to the documentation, I'm unsure why though.

The "usage" docs of the plugin show this:

import { remarkExtendedTable, extendedTableHandlers } from 'remark-extended-table';

import { unified } from 'unified';
import remarkParse from 'remark-parse';
import remarkRehype from 'remark-rehype';
import rehypeStringify from 'rehype-stringify';
import remarkGfm from 'remark-gfm';

const md = `
| a | b |
|---|---|
| 1 | 2 |
| ^ | 3 |
`;

const process = (md: string) =>
  unified()
    .use(remarkParse)
    .use(remarkGfm)
    .use(remarkExtendedTable)
    .use(remarkRehype, null, {
      handlers: {
        // any other handlers
        ...extendedTableHandlers,
      }
    })
    .use(rehypeStringify)
    .process(md);

But I'm unsure on how to translate this into Docusaurus. The docusaurus docs don't say anything about this besides adding a plugin the way I did at the start.

The plugin docs also mention that trying to disable remarkGfm could solve issues, but I'm sure docusaurus doesn't use that by default anyway(?).

[slorber]

As far as I know, MDX 1 has GFM hardcoded so you can't turn it off.

I guess this will work better after we upgrade to MDX 2, which will allow you to register this plugin just before remark-gfm

[Airkro]

This problem bother me for a long time too, there is no way to add handlers to remark-rehype in the docusaurus project.

You can use rehype-extended-table to replace remark-extended-table.

[homotechsual]

Yeah we really would benefit from a method to add remark-rehype handlers in Docusaurus - it's a fairly common pattern (remark-definition-list also uses it)

[slorber]

Would it solve the problem if we exposed siteConfig.markdown.remarkRehypeOptions?

This has also been requested in #9502

[homotechsual]

Yeah, that would solve the issue :-)

[CrazyOrr]

Yes, we really need a way to config remark-rehype.

[slorber]

PR to track: #9674