diff --git a/CONTRIBUTING_DOC.md b/CONTRIBUTING_DOC.md index 717d852c89c21330fde40cbc58664e29a8053064..53a1a63281e5aed7f04333637b0d494362414829 100644 --- a/CONTRIBUTING_DOC.md +++ b/CONTRIBUTING_DOC.md @@ -79,7 +79,7 @@ The procedure for submitting the modification is the same as that for submitting ``` -- A blank line must be added before and after an image and an image title. Otherwise, the typesetting will be abnormal. +- A blank line must be added before and after an image and an image title. Otherwise, the typesetting will be abnormal. For example as correctly: ``` Example: @@ -91,6 +91,19 @@ The procedure for submitting the modification is the same as that for submitting The following content. ``` +- A blank line must be added before and after a table. Otherwise, the typesetting will be abnormal. Tables are not supported in ordered or unordered lists. For example as correctly: + + ``` + ## Title + + | Header1 | Header2 + | :----- | :---- + | Body I1 | Body I2 + | Body II1 | Body II2 + + The following content. + ``` + - Mark the reference interface, path name, file name in the tutorial and document with "\` \`". If it's a function or method, don't use parentheses at the end. For example: - Reference method diff --git a/CONTRIBUTING_DOC_CN.md b/CONTRIBUTING_DOC_CN.md index 173e1b681ad82ac03830322e6fd5e2e47c81d719..2ed49dbd3769e654dd699a9f26e6ad8fe058135d 100644 --- a/CONTRIBUTING_DOC_CN.md +++ b/CONTRIBUTING_DOC_CN.md @@ -79,7 +79,7 @@ ``` -- 图和图标题前后需增加一个空行,否则会导致排版异常。 +- 图和图标题前后需增加一个空行,否则会导致排版异常。正确举例如下: ``` 如下图所示: @@ -91,6 +91,19 @@ 下文内容。 ``` +- 表格前后需增加一个空行,否则会导致排版异常。有序或无序列表内不支持表格。正确举例如下: + + ``` + ## 文章标题 + + | 表头1 | 表头2 + | :----- | :---- + | 内容I1 | 内容I2 + | 内容II1 | 内容II2 + + 下文内容。 + ``` + - 教程、文档中引用接口、路径名、文件名等使用“\` \`”标注,如果是函数或方法,最后不加括号。举例如下: - 引用方法