Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[自动化的中文文案排版指北] 遵循中文文案排版指北 #314

Open
dogeow opened this issue Mar 13, 2023 · 3 comments
Open

Comments

@dogeow
Copy link

dogeow commented Mar 13, 2023

这个功能解决了什么问题

风格统一

你建议的方案是什么

建议哈。这个排版可以弄个自动化,然后遵循 中文文案排版指北 ,我自己也是有写一套正则替换的,会比 MediaWiki 转 Markdown 之类的简单得多。
image

@dogeow dogeow changed the title [中文风格自动处理] 中英文空格的自动 [自动化的中文文案排版指北] 遵循中文文案排版指北 Mar 13, 2023
@xiaosansiji
Copy link
Collaborator

好提议,我之前写文档确实也是在遵循“指北”这个文档,不过写的人多了纯靠自觉或者人工也保障不了,你有什么比较好的中文文档排版 lint 规则或者 prettier 插件推荐不?

@dogeow
Copy link
Author

dogeow commented Mar 14, 2023

我用正则,功能比较简陋。插件的,我用了 chatgpt 找到这些,你看看。

对于中文文档排版规则的 lint,我推荐使用中文文案排版指南(简体中文版)中提供的工具——textlint,它是一个基于 JavaScript 的文本满足特定规则的校验器,可以用于 Markdown、HTML 和纯文本等格式的文件。你可以在 textlint 的 rule list 中找到很多适用于中文文档的规则,例如:

no-mix-dearu-desumasu:禁止混用敬语和非敬语;
no-space-before-punctuation:禁止在标点符号前面加空格;
zh-cn/no-space-between-numbers:禁止阿拉伯数字之间出现空格;
zh-cn/space-between-zh-and-en:中英文之间需要增加空格。
如果你使用 Visual Studio Code 编辑器,可以安装插件 textlint-plugin-vscode,它提供了 textlint 在 VS Code 中的集成,可以实时检测你的文本并提示错误。

对于 prettier 插件,在中文文档排版方面其实并没有太多优化,因为大部分排版规则都是基于中文排版指北中提供的。不过,你仍然可以尝试使用 prettier-plugin-text 插件,它对文本进行自动格式化,包括修复换行、缩进、空格等问题,可能会帮助你更好地排版你的文档。

@xiaosansiji
Copy link
Collaborator

还找到个这个 https://github.com/Jinjiang/zhlint
我试一下

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants