Markdown 文档写作规范 - 标点符号与文本分割
- 全角与半角: 推荐在中文环境下使用全角标点符号,在英文环境下使用半角标点符号,以保持文本的一致性和可读性。
- 中文全角标点示例:
,。!?;:()【】——“”‘’《》(注:中文环境下的引号通常使用全角)
- 英文半角标点示例:
,.!?;:()[]"'()
- 中文全角标点示例:
- 大小写: 在代码、命令、文件名等需要准确表示的情况下,保持英文大小写的准确性。
- 数字: 对于数字,保持其格式的一致性,例如在列举、日期、时间、代码等场景中使用阿拉伯数字。
- 代码前后空格: 在代码与普通文本之间添加空格,以提高代码的可读性。
请使用命令 `git status` 查看当前状态。 错误示例:请使用命令git status``查看当前状态。 `
- 列表前后空行: 在列表前后添加空行,以区分不同的段落或列表。
这是一个普通段落。 - 列表项一 - 列表项二``` 错误示例: ```markdown 这是一个普通段落。- 列表项一- 列表项二`
- 链接前后空格: 在链接前后添加空格,以区分链接文本和其他内容。
正确示例:访问 官方网站 了解更多信息。
错误示例:访问官方网站了解更多信息。
- 使用空格:在英文字母、数字和代码之间添加空格
- 使用中文字符
- 使用"你"代替"您"