Back to Shardingsphere

Document.Cn

docs/community/content/involved/conduct/document.cn.md

5.5.3732 B
Original Source

+++ title = "文档规范" weight = 3 chapter = true +++

  • 文档标题仅在 title = "xxx" 中出现, 文档内部无需主标题(#);
  • 每篇文档结尾留一空行;
  • 为避免段落过长,请在句号结尾处换行;
  • 标题和内容需要保留空行;
  • 为方便阅读,除了最后一列,表格的每列需要严格对齐;
  • 表格表头的 |- 之间需要保留一个空格;
  • 数字标记的段落均使用 1. ,由 Hugo 自动生成序号;
  • 列表项使用结尾,最后一项用结尾;
  • 请勿在英文文档中使用中文字符;
  • 中英文之间需要空格;
  • 图片文件结尾使用语言缩写以区分图片中的不同语言,如:_cn_en