Package Exports
- hexo-filter-copywriting
- hexo-filter-copywriting/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (hexo-filter-copywriting) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Hexo Filter Copywriting 中文文案排版过滤器
一个强大的 Hexo 过滤器,它能根据成熟的中文文案排版规范,自动优化你的文章内容。它能智能地添加空格、统一标点符号、修正专有名词,从而提升文章的可读性与专业性,同时能安全地忽略所有代码块。
功能特性
- 基于
pangu.js,自动在中日韩(CJK)字符与拉丁字母/数字之间添加空格 - 在中文语境下,智能地将半角标点转换为全角,并将
“”等引号替换为更美观的「」 - 使用可自定义的词典,自动修正常见技术名词的大小写(例如
github->GitHub) - 智能处理行内元素(如
<code>、<a>、<strong>等)周围的空格,避免在标点符号附近添加不必要的空格 - 自动处理文章标题和摘要,应用相同的文案排版规则
- 支持 Markdown 语法元素的智能空格处理(如
**粗体**、*斜体*、[链接](url)等) - 忽略所有
<pre>和<code>标签内的内容,确保代码片段不会被错误修改 - 自动跳过被明确标记为非 CJK(中日韩)语言(如
lang: en)的文章 - 你可以在
_config.yml中独立开启或关闭每一套规则(空格、标点、专有名词)
安装
在你的 Hexo 项目根目录下,使用 npm 进行安装。
npm install hexo-filter-copywriting --save
hexo clean使用方法
该插件在安装后会自动运行。你可以在你博客站点的根 _config.yml 文件中对它进行自定义配置。
配置
将以下配置块添加到你的根
_config.yml文件中,以控制过滤器的行为。如果不存在这个配置块,所有功能将默认对 CJK 语言文章开启。copywriting: enable: true # 用于开启或关闭所有格式化功能的总开关 pangu: true # 中英文空格 punctuation: true # 标点符号转换 (例如 “” -> 「」) proper_nouns: true # 专有名词大小写修正 (例如 github -> GitHub)创建名词词典
要使用“专有名词修正”功能,请在你的 Hexo 项目根目录下创建一个名为
dictionary.json的文件。{ "github": "GitHub", "react": "React", "javascript": "JavaScript", "js": "JS", "css": "CSS", "html": "HTML", "ajax": "AJAX", "npm": "npm" }
如果未找到此文件,该功能则会被跳过。
开发理念与致谢
本插件的目的是将社区中广为流传的、优秀的中文文案排版规范自动化,以提升文章的可读性。它是对以下两份重要指南中核心原则的具体代码实现:
我们的目标是让这些繁琐的排版细节能够被自动处理,从而让写作者可以更专注于内容本身。欢迎提出贡献和新的规则建议。
许可证
基于 MIT 许可证 发布。