From 8091bbff404e971245796475f567dcdd52126313 Mon Sep 17 00:00:00 2001 From: Dongjoon Lee Date: Mon, 24 Oct 2022 21:29:43 +0900 Subject: [PATCH 1/3] docs: add Solid to JSX in getting-started.server.mdx --- docs/docs/getting-started.server.mdx | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docs/docs/getting-started.server.mdx b/docs/docs/getting-started.server.mdx index 4138eee21..1cbde4077 100644 --- a/docs/docs/getting-started.server.mdx +++ b/docs/docs/getting-started.server.mdx @@ -124,6 +124,8 @@ your JSX runtime. * If you’re using **Theme UI**, install and configure [`@mdx-js/react`][mdx-react]. Then wrap your MDX content in a `` +* If you’re using **Solid**, + install [`solid-jsx`][solid-jsx]. Set [`options.jsxImportSource`][options-jsximportsource] to `'solid-jsx'`. Other JSX runtimes are supported by setting [`options.jsxImportSource`][options-jsximportsource]. @@ -137,6 +139,7 @@ For more info on the aforementioned tools, please see their dedicated sections: [¶ Svelte][svelte], [¶ Theme UI][themeui], or [¶ Vue][vue]. +[¶ Solid][solid], ### Editor @@ -857,6 +860,22 @@ for context based component passing. See also [¶ Vite][vite] and [¶ Vue CLI][vue-cli], which you might be using, for more info. +#### Solid +
+ Expand example + + ```js path="example.js" + import {compile} from '@mdx-js/mdx' + + const js = String(await compile('# hi', {jsxImportSource: 'solid-jsx', /* otherOptions… */})) + ``` +
+ +Solid is supported when [`options.jsxImportSource`][options-jsximportsource] is +set to `'solid-jsx'`. + +See also [¶ Vite][vite], [¶ Rollup][rollup] which you might be using, for more info. + ### JavaScript engines #### Node.js @@ -877,6 +896,8 @@ See their readmes on how to configure them. [svelte-jsx]: https://github.com/kenoxa/svelte-jsx +[solid-jsx]: https://github.com/high1/solid-jsx + [jsx]: #jsx [support]: /community/support/ @@ -943,6 +964,8 @@ See their readmes on how to configure them. [svelte]: #svelte +[solid]: #solid + [themeui]: #theme-ui [vite]: #vite From a2014efdfd8ed7d1f4725ac1f704d6d44e174591 Mon Sep 17 00:00:00 2001 From: Dongjoon Lee Date: Mon, 24 Oct 2022 21:46:32 +0900 Subject: [PATCH 2/3] style: update docs for remark-lint --- docs/docs/getting-started.server.mdx | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/docs/getting-started.server.mdx b/docs/docs/getting-started.server.mdx index 1cbde4077..4ff28ae49 100644 --- a/docs/docs/getting-started.server.mdx +++ b/docs/docs/getting-started.server.mdx @@ -125,7 +125,9 @@ your JSX runtime. install and configure [`@mdx-js/react`][mdx-react]. Then wrap your MDX content in a `` * If you’re using **Solid**, - install [`solid-jsx`][solid-jsx]. Set [`options.jsxImportSource`][options-jsximportsource] to `'solid-jsx'`. + install [`solid-jsx`][solid-jsx]. + Set [`options.jsxImportSource`][options-jsximportsource] to + `'solid-jsx'`. Other JSX runtimes are supported by setting [`options.jsxImportSource`][options-jsximportsource]. @@ -861,6 +863,7 @@ See also [¶ Vite][vite] and [¶ Vue CLI][vue-cli], which you might be using, for more info. #### Solid +
Expand example @@ -874,7 +877,8 @@ for more info. Solid is supported when [`options.jsxImportSource`][options-jsximportsource] is set to `'solid-jsx'`. -See also [¶ Vite][vite], [¶ Rollup][rollup] which you might be using, for more info. +See also [¶ Vite][vite] and [¶ Rollup][rollup] which you might be using, for +more info. ### JavaScript engines @@ -962,10 +966,10 @@ See their readmes on how to configure them. [snowpack]: #snowpack -[svelte]: #svelte - [solid]: #solid +[svelte]: #svelte + [themeui]: #theme-ui [vite]: #vite From 3468305df38dec645165196ef44c59230ecd50ee Mon Sep 17 00:00:00 2001 From: Dongjoon Lee Date: Mon, 24 Oct 2022 22:04:00 +0900 Subject: [PATCH 3/3] style: docs list is sorted alphabetically. --- docs/docs/getting-started.server.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/docs/getting-started.server.mdx b/docs/docs/getting-started.server.mdx index 4ff28ae49..24d4ed5d3 100644 --- a/docs/docs/getting-started.server.mdx +++ b/docs/docs/getting-started.server.mdx @@ -138,10 +138,10 @@ For more info on the aforementioned tools, please see their dedicated sections: [¶ Emotion][emotion], [¶ Preact][preact], [¶ React][react], +[¶ Solid][solid], [¶ Svelte][svelte], [¶ Theme UI][themeui], or [¶ Vue][vue]. -[¶ Solid][solid], ### Editor @@ -898,10 +898,10 @@ See their readmes on how to configure them. [@next/mdx]: https://github.com/vercel/next.js/tree/canary/packages/next-mdx -[svelte-jsx]: https://github.com/kenoxa/svelte-jsx - [solid-jsx]: https://github.com/high1/solid-jsx +[svelte-jsx]: https://github.com/kenoxa/svelte-jsx + [jsx]: #jsx [support]: /community/support/