言·旅·此

指南 入门

脚本说明:文章格式自动化规范

format-posts.ts 是一个用于自动规范 Markdown 文章格式的脚本。它主要解决中英文混排时的空格问题、标点符号纠正等,确保文章排版符合中文文案排版指北。

功能特性

  • 中英文混排优化:在中文与英文、数字之间自动添加空格。
  • 标点纠正:修正错误的标点符号使用。
  • Frontmatter 保护:脚本会自动识别并跳过 Markdown 顶部的 YAML Frontmatter 区域,仅对正文内容进行格式化。
  • 批量处理:一键扫描并格式化 src/content 目录下的所有 .md.mdx 文件。

使用方法

在终端中运行以下命令:

pnpm format-posts

技术实现

该脚本基于 autocorrect-node 开发,这是一个高性能的文案排版纠正工具。

工作原理

  1. 扫描文件:使用 fast-glob 查找 src/content 目录下所有的 Markdown 文件。
  2. 内容拆分:通过正则表达式将文件内容拆分为 Frontmatter 和正文两部分。
  3. 执行格式化:调用 autocorrect 对正文部分进行处理。
  4. 写回文件:如果格式化后的内容与原内容不同,则将更新后的内容写回磁盘。

示例

格式化前: 这是一段test文字,包含了123数字。

格式化后: 这是一段 test 文字,包含了 123 数字。