一些卢瑟帝国关于 Markdown 文档的规范 #275
Suzukaze7
started this conversation in
Show and tell
Replies: 2 comments
-
|
此外,仓库根目录下有 .markdownlint.jsonc 文件,仓库的 markdown 文件都要能通过 markdownlint 的检查。 对于 vscode,建议安装 markdownlint 插件。 |
Beta Was this translation helpful? Give feedback.
0 replies
-
|
我觉得可以把这个规范整理下放到 CONTRIBUTING.md 里。 |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
一些卢瑟帝国关于 Markdown 文档的规范:
行内代码等英文应当与中文间隔一个空格,例如:
不同的部分应当用空行隔开,例如:列表、引用、代码段前后应当空行:
文件最后需要留一行空行
每行行末要么留两个空格代表换行,要么不留空格
一句话表达的意思完整需要加句号,反之需要加分号;如果与下文有联系则需要加冒号:
Beta Was this translation helpful? Give feedback.
All reactions