docs(guides/mdx): mention including highlight.js css file

[dwjohnston]

The current example shows using rehype-highlight. However, without a highlight.js css file, only monospaced text will appear.

Given that the example is mentioning rehype-highlight it think it's worth also mentioning including the CSS, or remove rehype-highlight from the example.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 5ffdf0b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[remix-cla-bot]

Hi @dwjohnston,

Welcome, and thank you for contributing to Remix!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at [email protected].

Thanks!

- The Remix team

[remix-cla-bot]

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳

[dwjohnston]

I could include an example of the change to your root.tsx that is required. However, that might clutter the documenation/distract.

The required change to root.tsx is:

//root.tsx
+ import styles from 'highlight.js/styles/vs2015.css';
+
+ export const links: LinksFunction = () => {
+     return [{ rel: "stylesheet", href: styles }];
+ };

[machour]

Suggested change

	The above configuration parses markdown to insert [highlight.js][highlightjs] friendly DOM elements. To have the syntax highlighting appear, you need also include a highlight.js css file. See [Surfacing Styles][surfacing-styles].
	The above configuration parses the markdown to insert [highlight.js][highlightjs] friendly DOM elements. To have the syntax highlighting appear, you will also need to include the highlight.js css file. See also [surfacing styles][surfacing-styles].

[machour]

Reworded things a bit.
I'm fine with adding this remark.