[FAQ] Markdown 常见问题

[Kunduin]

本项目使用正在使用的 markdown 解释器正在改进中，有疑问可以在这里留言。

为什么我提交的文档在 vscode & gitlab & github 上显示正常，但是提交到网页上却完全不一样？

目前 markdown 的常见规范有两个 commonMarkdown & GitHub Flavored Markdown。网页正在使用的 markdown 解释器 支持 这两种规范。

但是！但是！规范只规定了满足规范的地方应该怎么处理，所有 不满足规范的写法 具体应该如何处理，不同的解释器使用了不同的解决办法。所以很遗憾的，因为 vscode & gitlab & github 上面的 markdown 解释器经过多个版本的迭代，对大多数用户的骚操作写法都有比较好的优化。而我们使用的开源项目没有这么高的觉悟。所以显示出来的效果会与以上三者不同。

我该怎么保证我写出来的效果在网页上显示和理想的显示一样？

1. 严格、严格遵循这两个 markdown 规范 （commonMarkdown & GitHub Flavored Markdown），不使用骚操作。
2. 我们在本版本使用 marked 作为项目 markdown 解释器，各位同学可以使用这个网页 https://marked.js.org/demo 测试自己的写法是否能够正常显示