Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Solid to JSX section in Getting Started guide #2159

Merged
merged 3 commits into from Oct 24, 2022
Merged

Add Solid to JSX section in Getting Started guide #2159

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8091bbf
docs: add Solid to JSX in getting-started.server.mdx
Djunnni Oct 24, 2022
a2014ef
style: update docs for remark-lint
Djunnni Oct 24, 2022
3468305
style: docs list is sorted alphabetically.
Djunnni Oct 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/docs/getting-started.server.mdx
View file
Open in desktop
Expand Up @@ -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 `<ThemeProvider />`
* If you’re using **Solid**,
install [`solid-jsx`][solid-jsx]. Set [`options.jsxImportSource`][options-jsximportsource] to `'solid-jsx'`.
wooorm marked this conversation as resolved.
Show resolved Hide resolved

Other JSX runtimes are supported by setting
[`options.jsxImportSource`][options-jsximportsource].
Expand All @@ -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],
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Move this above Svelte. The list is sorted alphabetically.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if you’re still working on this or thought it was fixed. But to be as clear as possible: I meant: this line L144, should be above L141 (Svelte)! :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

got it!


### Editor

Expand Down Expand Up @@ -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
<details>
wooorm marked this conversation as resolved.
Show resolved Hide resolved
<summary>Expand example</summary>

```js path="example.js"
import {compile} from '@mdx-js/mdx'

const js = String(await compile('# hi', {jsxImportSource: 'solid-jsx', /* otherOptions… */}))
```
</details>

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.
wooorm marked this conversation as resolved.
Show resolved Hide resolved

### JavaScript engines

#### Node.js
Expand All @@ -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/
Expand Down Expand Up @@ -943,6 +964,8 @@ See their readmes on how to configure them.

[svelte]: #svelte

[solid]: #solid

[themeui]: #theme-ui

[vite]: #vite
Expand Down