MDX Preview for Visual Studio Code:即时预览,无需启动开发服务器
MDX Preview for Visual Studio Code是一款革命性的扩展工具,旨在为开发者提供无缝的MDX预览体验。无论您是编写markdown还是JSX,都能在编辑过程中实时看到效果,极大地提升开发效率。

功能亮点:
- 即时预览,无需启动开发服务器: 只需安装必要的npm依赖,打开您的.md或.mdx文件,即可通过命令面板使用"MDX: Open Preview"功能,享受即时预览带来的便捷。文件更改时,预览将自动更新。
- 自定义布局: 您可以通过导出默认布局值、指定自定义布局配置文件路径,或使用默认的VS Code Markdown样式来自定义MDX文件的布局。
- MDX嵌入: 支持导入其他.md或.mdx文件,实现内容的灵活嵌入。
- JavaScript/TypeScript预览: 如果您有渲染到#root元素的JavaScript或TypeScript文件,也可以使用MDX Preview进行预览。
- 安全性: 代码仅在VS Code扩展程序webview的隔离iframe中评估,确保安全性。您可以根据需要调整安全设置。
扩展设置:
- mdx-preview.preview.previewOnChange: 文件更改时预览
- mdx-preview.preview.security: 安全策略设置
- mdx-preview.preview.useVscodeMarkdownStyles: 使用VS Code Markdown样式
- mdx-preview.preview.useWhiteBackground: 使用白色背景
- mdx-preview.preview.mdx.customLayoutFilePath: 自定义布局文件路径
- mdx-preview.build.useSucraseTranspiler: 使用sucrase作为转译器
常见问题解答:
- 工作原理: MDX Preview使用@mdx-js/mdx转译您的.mdx文件,并通过polestar递归获取本地和npm依赖。
- 组件不工作? 运行时错误会在react-error-overlay中显示,您也可以使用开发者工具进行调试。
路线图:
- [x] TypeScript支持
- [ ] 滚动同步
- [ ] remark/rehype插件
- [ ] 与gatsby / x0 /...的集成
致谢:
感谢James和开源项目polestar的帮助,以及其他开源项目的灵感和支持,包括Codesandbox preview for Atom、@mdx-js/mdx、gatsby-mdx、markdown-language-features、codesandbox和mdx extension。
支持项目发展:
请考虑通过♡ GitHub Sponsorship支持该项目的开发,您将在赞助者页面上显示个人资料徽章!
本站所有资源都是由网友投稿发布,或转载各大下载站,
请自行检测软件的完整性!
本站所有资源仅供学习与参考,请勿用于商业用途,否则
产生的一切后果将由您自己承担!
如有侵权请联系我们删除下架,联系方式:study_golang@163.com