Skip to content

Commit bfe1b17

Browse files
dwjohnstonmachourMichaelDeBoey
authored
docs(guides/mdx): mention including highlight.js css file (#4571)
Co-authored-by: Mehdi Achour <[email protected]> Co-authored-by: Michaël De Boey <[email protected]>
1 parent ab6a6f0 commit bfe1b17

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

contributors.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,7 @@
177177
- dunglas
178178
- dvargas92495
179179
- dwightwatson
180+
- dwjohnston
180181
- dwt47
181182
- dylanplayer
182183
- eastlondoner

docs/guides/mdx.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,8 +204,12 @@ exports.mdx = async (filename) => {
204204
};
205205
```
206206

207+
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].
208+
207209
[mdx-plugin]: https://mdxjs.com/packages/rollup
208210
[mdx]: https://mdxjs.com
209211
[yaml]: https://yaml.org
210212
[mdx-bundler]: https://github.com/kentcdodds/mdx-bundler
211213
[classic-remix-compiler]: ./vite#classic-remix-compiler-vs-remix-vite
214+
[surfacing-styles]: ../styling#surfacing-styles
215+
[highlightjs]: https://highlightjs.org/

0 commit comments

Comments
 (0)