Closed gytxtx closed 6 months ago
我发现这个存储库的 README 存在一些排版问题,对此我想提出一些建议:
将存储库的 README、"关于 (GitHub 电脑版网页右侧的)" 等文本排序方式 按照 https://github.com/sparanoid/chinese-copywriting-guidelines 的规则进行修改。
README
添加空格 根据 sparanoid 的中文排版指南 的规则,我们应该在相关链接和其他文本之间添加空格。 相关链接: sparanoid 的中文排版指南
善用 Markdown 排版 Markdown 是一种强大的工具,可以帮助我们更好地排版文本。
Markdown
例如,在文件名中使用 Monospace,这可以使文本看起来更美观。
Monospace
就像这样: index.html
index.html
`index.html`
改用正确的大小写 将 Github 改为 GitHub
Github
GitHub
如果我有不对的地方,请及时指正,感谢!
感谢提醒。
我习惯把 Readme 当作便签来使用,没有太多考虑规范的问题。近期我会整理项目文档和 Readme,到时再进行相关优化。
另外关于等宽字体的使用,我有不同意见:Markdown 的代码块应该只用于展示代码,而不是碰着个英文单词就放代码块。
🤔 你说得好像也有道理
我发现这个存储库的 README 存在一些排版问题,对此我想提出一些建议:
将存储库的
README
、"关于 (GitHub 电脑版网页右侧的)" 等文本排序方式 按照 https://github.com/sparanoid/chinese-copywriting-guidelines 的规则进行修改。添加空格 根据 sparanoid 的中文排版指南 的规则,我们应该在相关链接和其他文本之间添加空格。 相关链接: sparanoid 的中文排版指南
善用
Markdown
排版 Markdown 是一种强大的工具,可以帮助我们更好地排版文本。例如,在文件名中使用
Monospace
,这可以使文本看起来更美观。就像这样:
index.html
改用正确的大小写 将
Github
改为GitHub
如果我有不对的地方,请及时指正,感谢!