v8 development

.changeset/dry-melons-press.md

@@ -0,0 +1,5 @@
+---
+'markdown-to-jsx': major
+---
+
+Bump minimum React version to 16+. `markdown-to-jsx` can now return strings directly without needing a wrapper unless forced via `options.forceWrapper`.

.changeset/five-frogs-repair.md

@@ -0,0 +1,5 @@
+---
+'markdown-to-jsx': minor
+---
+
+Add `options.enableRules` and `options.disableRules`; this allows for individual syntaxes to be conditionally switched on/off as desired.

.changeset/sour-llamas-develop.md

@@ -0,0 +1,5 @@
+---
+'markdown-to-jsx': minor
+---
+
+Add `options.customRules`, this allows for novel functionality to be implemented in tandem with `options.renderRule`.

.changeset/spicy-cherries-suffer.md

@@ -0,0 +1,16 @@
+---
+'markdown-to-jsx': major
+---
+
+Introduce the `createMarkdown(options)` factory function. This factory wraps and replaces the prior `compiler(input, options)` top-level export, while also exposing the AST parser directly for ✨ advanced use cases ✨.
+
+```tsx
+import { createMarkdown } from 'markdown-to-jsx'
+
+// parser = receive AST without going directly to React, allows for complete override
+// compiler = parser + React output (the equivalent of using the `Markdown` component)
+// Markdown = React component for convenience
+const { Markdown, compiler, parser } = createMarkdown({
+  /* any options here */
+})
+```

benchmark.js

@@ -3,7 +3,7 @@ import cliProgress from 'cli-progress'
 import * as fs from 'fs'
 import SimpleMarkdown from 'simple-markdown'
 import MarkdownIt from 'markdown-it'
-import { compiler } from './dist/index.module.js'
+import { createMarkdown } from './dist/index.module.js'
 
 const mdIt = new MarkdownIt()
 const suite = new BenchTable()
@@ -18,6 +18,8 @@ const bar = new cliProgress.SingleBar(
 )
 let totalCycles
 
+const { compiler } = createMarkdown()
+
 // add tests
 suite
   .addFunction('markdown-to-jsx', input => compiler(input))

index.cjs.tsx

@@ -1,3 +1,6 @@
-import Markdown, { compiler } from './'
-Object.assign(Markdown, { compiler })
-export default Markdown as typeof Markdown & { compiler: typeof compiler }
+import Markdown, { createMarkdown } from './'
+
+Object.assign(Markdown, { createMarkdown })
+export default Markdown as typeof Markdown & {
+  createMarkdown: typeof createMarkdown
+}