refactor: adjust type documentation

README.md

@@ -420,7 +420,7 @@ function App() {
     <Markdown
       children={exampleContent}
       options={{
-        renderRule(next, node, renderAST, state) {
+        renderRule(next, node, renderChildren, state) {
           if (node.type === RuleType.codeBlock && node.lang === 'latex') {
             return (
               <TeX as="div" key={state.key}>{String.raw`${node.text}`}</TeX>

index.compiler.spec.tsx

@@ -3745,7 +3745,7 @@ describe('options.renderRule', () => {
   it('should allow arbitrary modification of content', () => {
     render(
       compiler('Hello.\n\n```latex\n$$f(X,n) = X_n + X_{n-1}$$\n```\n', {
-        renderRule(defaultRenderer, node, output, state) {
+        renderRule(defaultRenderer, node, renderChildren, state) {
           if (node.type === RuleType.codeBlock && node.lang === 'latex') {
             return <div key={state.key}>I'm latex.</div>
           }

index.tsx

@@ -2267,7 +2267,7 @@ export namespace MarkdownToJSX {
      * For example, to implement a LaTeX renderer such as `react-katex`:
      *
      * ```
-     * renderRule(next, node, output, state) {
+     * renderRule(next, node, renderChildren, state) {
      *   if (node.type === RuleType.codeBlock && node.lang === 'latex') {
      *     return (
      *       <TeX as="div" key={state.key}>
@@ -2287,8 +2287,11 @@ export namespace MarkdownToJSX {
     renderRule: (
       /** Resume normal processing, call this function as a fallback if you are not returning custom JSX. */
       next: () => React.ReactChild,
+      /** the current AST node, use `RuleType` against `node.type` for identification */
       node: ParserResult,
-      renderAST: RuleOutput,
+      /** use as `renderChildren(node.children)` for block nodes */
+      renderChildren: RuleOutput,
+      /** contains `key` which should be supplied to the topmost JSX element */
       state: State
     ) => React.ReactChild
 

site.tsx

@@ -320,7 +320,7 @@ const options = {
       component: MyComponent,
     },
   },
-  renderRule(defaultOutput, node, renderAST, state) {
+  renderRule(defaultOutput, node, renderChildren, state) {
     if (node.type === RuleType.codeBlock) {
       if (node.lang === 'latex') {
         return (