Skip to content

Commit

Permalink
📝 更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
zidoshare committed Feb 20, 2021
1 parent 565a086 commit a5e87f2
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
# Markit

专为中文语境优化的 Markdown 命令行工具,包含:
> 专为中文语境优化的 Markdown 命令行工具
# 关于

该项目为从命令行使用markdown提供了一个简单的配套解决方案。

包含:

* 解析
* 渲染
* 导出
* 格式化
* 渲染

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

格式化处理项

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

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

Expand Down
5 changes: 2 additions & 3 deletions cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,16 @@ var rootCmd = &cobra.Command{
Short: "专为中文语境优化的 Markdown 命令行工具",
Long: `专为中文语境优化的 Markdown 命令行工具,包含:
* 解析
* 渲染
* 导出
* 格式化
* 渲染
针对中文语境,它参考 中文文案排版指北 [https://github.com/sparanoid/chinese-copywriting-guidelines](https://github.com/sparanoid/chinese-copywriting-guidelines)
格式化处理项
* 中英文之间增加空格(排除 "ing", 例如工作中,可能写为 "工作ing",这种情况不会自动加空格)
* 专有名词使用正确的大小写(例如 自动将 'github' 转换为 'Github')
* 自动处理表格对齐(务必使用等宽字符)
可以提供整个项目文档的统一处理,特别是在处理 Gitbook 等项目时,能够在多人合作中实现格式统一。
Expand Down

0 comments on commit a5e87f2

Please sign in to comment.