无论您是想要统一中文排版风格、改进文字质量还是提高技术文章的清晰度与易读性,以上推荐的几个开源项目都能满足您的需求。它们提供了详细的规范和指南,帮助您正确使用空格、标点符号以及中英文之间的排版等方面。这些项目还支持多种文件格式,并且具有灵活性和可定制性,让您能够根据自己的需要进行调整。无论您是初学者还是经验丰富的作者,在撰写中文文案或技术文档时,这些开源项目都将成为不可或缺的资源。
sparanoid/chinese-copywriting-guidelines
Stars: 12.9k
License: MIT
中文文案排版指北是一个用于统一中文文案和排版的开源项目。该项目旨在降低团队成员之间的沟通成本,增强网站气质。
以下是该项目的核心优势和关键特性:
- 空格:详细介绍了正确使用空格的规范,包括在中英文字之间、数字与单位之间以及全形标点符号等情况下需要增加空格。
- 标点符号:提供了正确使用标点符号并避免重复使用的建议。
- 全形和半形:解释了什么是全角字符 (即繁体字) 和半角字符,并给出相应用法建议。
- 名词大小写:提醒用户要注意专有名词是否采用合适大小写书写方式,并列举常见错误示例进行对比说明。
这个开源项目已经被多家知名公司广泛应用,例如 Apple 中国、Microsoft 中国等。同时,在 V2EX、Ruby China 等社区也得到积极参考借鉴。
ruanyf/document-style-guide
Stars: 11.0k
License: NOASSERTION
中文技术文档的写作规范是一个在 GitHub 上非常有价值的开源项目。
该项目主要提供了一套关于中文技术文档写作规范的指南,旨在帮助作者们更好地撰写清晰、准确和易读的技术文章。通过遵循这些规范,可以使得阅读者更容易理解并且快速掌握所述内容。
以下是该项目核心优势和关键特性:
- 提供详细而全面的标准:该项目包含了标题、段落、数值等多个方面,并对每个方面都给出了具体建议与示例。
- 侧重实用性:针对不同类型或领域(如软件开发)下编写各类文件时可能存在问题进行讲解,并给出相应改进方法。
- 简洁明了:使用简单直接但又足够详尽以及可操作性强的语言描述相关知识点,在保证有效传达信息同时也节省用户时间成本。
- 公共领域协议:使用公共领域 (public domain) 协议发布,可自由复制修改分发。
如果您正在寻找一份完整而系统化的中文技术书籍风格指南,请务必考虑查看此仓库。无论你是否已经研究过技术写作规范,这个项目都能为你提供有价值的参考和指导。无论是初学者还是经验丰富的作者,在撰写中文技术文档时,该项目都将成为一个不可或缺的资源。
hotoo/pinyin
Stars: 7.0k
License: NOASSERTION
pīnyīn 是一个汉字拼音转换工具,可以用于汉字注音、排序和检索。
以下是该项目的核心优势和关键特性:
- 根据词组智能匹配最正确的拼音
- 支持多音字
- 简单的繁体支持
- 支持多种不同拼音风格
这个开源项目在将中文字符转换为拼音方面非常实用,并且提供了各种选项来满足用户需求。无论您需要进行汉字注释、排序还是搜索功能,都可以使用 pīnyīn 来轻松完成。它通过智能匹配确保准确性,并支持处理复杂情况下的多义词。此外,它还提供简单但有效地处理繁体中文以及选择不同风格输出结果等功能。
vinta/pangu.js
Stars: 3.9k
License: MIT
为什麼你们就是不能加个空格呢?
- 自动在中文字和半形的英文、数字、符号之间插入空白
- 盘古之白,劈开全形字和半形字混沌
- 支持多种程式语言
textlint/textlint
Stars: 2.6k
License: MIT
textlint 是一个可插拔的自然语言校对工具,适用于文本和 Markdown。它类似于 ESLint,但专门针对自然语言进行使用。
以下是 textlint 的核心优势:
- 没有捆绑规则。
- 通过 npm 安装想要的 textlint 规则来使用。
- 支持多种文件格式,默认支持 Markdown 和纯文本,并且可以通过插件扩展到 HTML 等其他文件格式。
- 可以使用自定义 formatter 来输出结果报告。
如果你需要一个强大而灵活的开源工具来帮助你检查并改进文字质量,那么 textlint 绝对值得一试!
ethantw/Han
Stars: 2.4k
License: MIT
“漢字標準格式” 是一个集 “语义样式标准化” “文字设计” “高阶排版功能” 三大概念的 Sass/Stylus、JavaScript 排版框架。其专为汉字网页提供美观而标准化的环境,不仅符合传统阅读习惯,更为屏幕阅读提供了既成标准,完整解决现今汉字网页设计的排版需求。
核心优势:
- 提供多项定制功能。
- 支持繁体中文、简体中文和日语等三种采用汉字的语言文字。
关键特性:
- 适应各类浏览器:Chrome (最新版本)、Edge (最新版本)、Firefox (最新版本) 等主流浏览器均支持该项目;
- 简单易用:使用 CDN 文件可实现高速下载及缓存,并且具有低耦合度和高度语意化特点;
- 定制灵活:通过变量设置和模块引入可以轻松自定义样式表。
huacnlee/autocorrect
Stars: 545
License: MIT
AutoCorrect 是一个基于 Rust 编写的开源项目,旨在提供一套标准化的文案较正方案。它可以帮助改善中日韩 (CJK) 文字与英语之间的空格、单词和标点符号使用,并且支持自定义字典进行拼写检查和纠正。
该项目具有以下关键特性和核心优势:
- 为 CJK 文字与英语单词添加正确的空格。
- 将标点符号校正到靠近 CJK 字体时采用全角形式。
- 在英文内容中将标点符号校正为半角形式。
- (实验功能) 通过用户自定义字典对单词进行拼写检查并纠错。
- 提供 Lint 功能,可输出差异或 JSON 结果以便集成至 CI 环境 (如 GitLab CI、GitHub Action、Travis CI...),从而能够检测代码中存在问题的文本内容,并达到统一规范效果。
- 支持超过 28 种文件类型 (包括 Markdown、JSON、YAML 和 JavaScript 等),利用 AST 解析器仅针对字符串及注释部分进行处理,跳过其他无需处理区域
题图:Photo by Aaron Burden on Unsplash