首页
/ Vale v3.10.0 发布:新增对MDX格式的原生支持

Vale v3.10.0 发布:新增对MDX格式的原生支持

2025-06-12 06:08:04作者:蔡丛锟

Vale 是一款开源的文本校验工具,主要用于检查文档中的语法、风格和术语一致性。它支持多种文档格式,包括 Markdown、AsciiDoc、HTML 等,并允许用户通过自定义规则来满足特定的写作规范要求。

在最新发布的 v3.10.0 版本中,Vale 引入了一项重要功能更新 - 原生支持 MDX 格式。MDX 是一种结合了 Markdown 和 JSX 的混合格式,它允许开发者在 Markdown 文档中直接嵌入 React 组件。随着 MDX 在前端文档编写中的普及,Vale 的这一更新使得开发者能够更方便地对包含 React 组件的文档进行校验。

核心更新内容

  1. 原生 MDX 支持:现在用户可以直接对 MDX 文件进行校验,无需额外配置 CommentDelimiters 或通过 [formats] 关联 Markdown 格式。这一改进大大简化了 MDX 文档的校验流程。

  2. 非表达式支持:新版本增强了对 {...} 块中非表达式内容的处理能力,这使得 Vale 能够更准确地识别和校验 MDX 文档中的各种内容结构。

  3. 依赖更新:项目升级了多个依赖库,包括将 expr-lang/expr 从 1.16.9 更新到 1.17.0,以及将 golang.org/x/net 从 0.34.0 更新到 0.36.0,提升了工具的稳定性和性能。

技术实现细节

Vale 通过集成 mdx2vast 工具来实现对 MDX 格式的解析。在 CI 流程中,系统会自动安装这一依赖,确保 MDX 处理功能的可用性。同时,开发团队还优化了命令执行流程,提高了工具的整体运行效率。

兼容性考虑

为了确保平滑升级,新版本特别考虑了向后兼容性。测试用例中包含了使用旧配置方式的 MDX 文件处理场景,确保现有用户的配置不会因为版本升级而失效。

使用建议

对于技术文档团队来说,这一更新意味着:

  1. 可以直接对包含 React 组件的文档进行风格和术语检查,无需额外转换步骤。
  2. 简化了配置流程,特别是对于已经使用 MDX 格式的项目。
  3. 提高了对现代文档格式的支持,使 Vale 能够更好地适应前端文档开发的工作流。

总结

Vale v3.10.0 的发布,特别是对 MDX 格式的原生支持,进一步巩固了它作为现代技术文档质量保障工具的地位。这一更新不仅提升了工具的实用性,也反映了 Vale 项目对开发者需求变化的快速响应能力。对于使用 MDX 编写文档的团队来说,升级到新版本将显著改善他们的文档校验体验。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8