0

0

VSCode的MDX支持:将JSX嵌入Markdown的完美体验

P粉986688829

P粉986688829

发布时间:2026-01-01 14:53:26

|

220人浏览过

|

来源于php中文网

原创

需安装MDX扩展、配置文件关联为MDX语言模式、集成Pretterr支持JSX格式化、启用ESLint校验内联JSX;依次完成四步即可实现VSCode中MDX文件的JSX高亮、补全、格式化与语法校验。

vscode的mdx支持:将jsx嵌入markdown的完美体验

如果您在VSCode中编写MDX文件,但发现JSX语法未被正确高亮、补全或预览,则可能是由于缺少对应的语言支持或配置不完整。以下是实现MDX中JSX嵌入功能的多种配置方式:

本文运行环境:MacBook Pro,macOS Sequoia。

一、安装MDX语言扩展

VSCode原生不识别.mdx文件类型,需通过官方推荐扩展启用语法支持与智能提示。该扩展提供基础的JSX高亮、括号匹配及属性补全能力。

1、打开VSCode左侧活动栏中的扩展视图(快捷键Ctrl+Shift+X或Cmd+Shift+X)。

2、在搜索框中输入MDX,找到由Michael Novotny发布的MDX扩展(图标为橙色“M”)。

3、点击“安装”,安装完成后重启VSCode或重新加载窗口(Ctrl+Shift+P → 输入“Developer: Reload Window”并执行)。

二、配置文件关联规则

即使安装了扩展,VSCode仍可能将.mdx文件默认以纯文本或Markdown模式打开,需手动绑定语言模式以激活JSX解析能力。

1、打开任意一个.mdx文件。

2、点击右下角显示的语言模式(如“Plain Text”或“Markdown”)。

3、在弹出的输入框中输入MDX,选择“MDX”选项。

4、点击“Configure file association for '.mdx'”,在settings.json中自动添加如下行:"files.associations": {"*.mdx": "mdx"}

Artflow.ai
Artflow.ai

可以使用AI生成的原始角色、场景、对话,创建动画故事。

下载

三、集成Prettier进行JSX格式化

MDX中混合JSX代码块时,标准Markdown格式化器无法处理标签缩进与换行逻辑,需使用支持JSX的Prettier配置确保结构清晰可读。

1、在项目根目录创建.prettierrc文件,内容包含:{"semi": true, "singleQuote": true, "jsxSingleQuote": true, "bracketSameLine": false}

2、安装Prettier扩展(搜索“Prettier - Code formatter”并安装)。

3、在VSCode设置中搜索format on save,勾选“Editor: Format On Save”。

4、确保工作区设置中已启用MDX支持:在settings.json中添加"[mdx]": {"editor.formatOnSave": true}

四、启用ESLint对内联JSX校验

MDX允许在{}中书写JavaScript表达式及JSX元素,ESLint可检测潜在语法错误、未声明变量及JSX props类型问题。

1、在项目中运行命令:npm install eslint @eslint/js eslint-plugin-react eslint-plugin-mdx --save-dev

2、创建.eslintrc.cjs,配置parserOptions为{ ecmaVersion: 2022, sourceType: 'module', ecmaFeatures: { jsx: true } }

3、在plugins数组中加入['react', 'mdx'],并在overrides中为'*.mdx'指定processor为'mdx/mjs'

4、安装ESLint扩展并启用“ESLint: Enable”工作区设置。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

542

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

372

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

727

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

470

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

392

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

990

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

654

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

544

2023.09.20

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

7

2025.12.31

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
React 教程
React 教程

共58课时 | 3.2万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 0.9万人学习

React核心原理新老生命周期精讲
React核心原理新老生命周期精讲

共12课时 | 1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号