Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

文档书写规范的想法 #51

Open
Jface001 opened this issue Mar 13, 2023 · 2 comments
Open

文档书写规范的想法 #51

Jface001 opened this issue Mar 13, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers plan|计划 Future plan.|我们项目未来的计划

Comments

@Jface001
Copy link
Member

文档书写规范的想法

  1. 一级标题仅限页面标题
  2. 分类首选二类标题,如无必要不超过三层标题
  3. 凸显内容使用粗体或者图片,例如赞助者可以使用头像超链接,或者图片链接
  4. 如无必要,不可使用标题字体
@yanboishere yanboishere added documentation Improvements or additions to documentation good first issue Good for newcomers plan|计划 Future plan.|我们项目未来的计划 labels Mar 14, 2023
@yanboishere
Copy link
Member

👍 很好的想法

@Jface001
Copy link
Member Author

格式补充想法:
1、遵循中文排版规则:https://github.com/sparanoid/chinese-copywriting-guidelines ,中英文、符号之间加上空格
2、标题不带不能带括号注释,不带英语单词
3、层级目录明确,上级目录写明下级目录不再重复(比如“区块链-区块链分叉” 应该改成 “区块链-分叉”

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers plan|计划 Future plan.|我们项目未来的计划
Projects
None yet
Development

No branches or pull requests

2 participants