首页
/ Vale v3.11.0 发布:Markdown 等文档格式的前端元数据校验支持

Vale v3.11.0 发布:Markdown 等文档格式的前端元数据校验支持

2025-06-12 22:02:50作者:鲍丁臣Ursa

Vale 是一款开源的文本校验工具,专注于为技术文档、博客文章等提供语法、风格和术语的自动化检查。它支持多种文档格式,包括 Markdown、AsciiDoc、reStructuredText 等,能够帮助技术写作者和内容创作者保持文档的一致性和专业性。

在最新发布的 v3.11.0 版本中,Vale 引入了一项重要功能:对多种文档格式中前端元数据(front matter)字段的校验支持。这一功能显著扩展了 Vale 的应用场景,使其能够更好地服务于现代文档工作流。

前端元数据校验功能详解

前端元数据是现代文档系统中常见的配置方式,通常位于文档开头,用于定义文档的标题、作者、描述等元信息。Vale v3.11.0 新增了对三种主流前端元数据格式的支持:

  1. YAML 格式:使用 --- 作为分隔符
  2. TOML 格式:使用 +++ 作为分隔符
  3. JSON 格式:使用大括号 {} 包裹

这一功能覆盖了 Markdown、AsciiDoc、reStructuredText、MDX 和 Org 等多种文档格式,满足了不同技术栈用户的需求。

技术实现与使用方式

Vale 通过为每个前端元数据字段动态分配独立的作用域(scope)来实现精确校验。例如,对于以下 YAML 格式的前端元数据:

---
title: "My document"
description: "A short summary of the document's purpose."
author: "John Doe"
---

Vale 会为每个字段生成对应的作用域:

  • text.frontmatter.title
  • text.frontmatter.description
  • text.frontmatter.author

用户可以在规则配置中针对特定字段设置校验规则。例如,要求标题字段必须使用标题大小写:

extends: capitalization
message: "'%s' should be in title case"
level: warning
scope: text.frontmatter.title

这种设计提供了极大的灵活性,允许用户为不同类型的元数据字段定义不同的校验标准。

实际应用场景

前端元数据校验功能在以下场景中特别有用:

  1. 文档标准化:确保团队所有文档的元数据字段格式一致
  2. SEO优化:校验描述字段的长度和关键词使用
  3. 多语言支持:检查本地化字段的完整性
  4. 发布流程控制:验证必填字段是否已填写

对于技术文档团队而言,这一功能可以显著提升文档质量管理的自动化程度,减少人工检查的工作量。

版本兼容性与升级建议

v3.11.0 版本保持了良好的向后兼容性,现有规则和配置无需修改即可继续使用。对于希望使用新功能的用户,建议:

  1. 检查现有文档中使用的前端元数据格式
  2. 根据团队规范设计相应的校验规则
  3. 逐步将新规则集成到持续集成流程中

该版本同时提供了 Linux、macOS 和 Windows 平台的二进制包,支持 x86 和 ARM 架构,方便不同环境的用户升级。

Vale 的这一更新体现了其对现代文档工作流的深入理解,通过精细化的校验能力,帮助团队提升文档质量和一致性。对于已经使用 Vale 的团队,升级到 v3.11.0 可以立即获得这一强大功能;对于新用户,现在也是开始使用 Vale 的好时机。

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

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
193
2.16 K
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Python
78
72
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
972
573
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
548
77
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
349
1.36 K
giteagitea
喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
17
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
206
284
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
60
17