Skip to content

专为中文语境优化的 Markdown 格式化工具

License

Notifications You must be signed in to change notification settings

zidoshare/markit

Repository files navigation

Markit

专为中文语境优化的 Markdown 格式化工具

关于

该项目为从命令行格式化 Markdown 提供了一个简单的解决方案。

针对中文语境,它参考 中文文案排版指北 https://github.com/sparanoid/chinese-copywriting-guidelines

格式化处理项

  • 中英文之间增加空格(排除 "ing", 例如工作中,可能写为 "工作 ing",这种情况不会自动加空格)
  • 专有名词使用正确的大小写(例如 自动将 github 转换为 Github)
  • 自动处理表格对齐(等宽字符)

可以提供整个项目文档的统一处理,特别是在处理 Gitbook 等项目时,能够在多人合作中实现格式统一。

安装

Go

go install -u github.com/zidoshare/markit@latest

🙏 鸣谢

站在巨人们的肩膀上:

  • 中文文案排版指北:统一中文文案、排版的相关用法,降低团队成员之间的沟通成本,增强网站气质
  • lute:一款对中文语境优化的 Markdown 引擎,支持 Go 和 JavaScript。

About

专为中文语境优化的 Markdown 格式化工具

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published