C1 Wiki 解析规范¶
本文介绍了 C1 Wiki 的解析规范。这是技术层面上 Mkdocs 对 C1 Wiki 所有文件的解析要求,如果不正确按照这些要求编写,可能会发生解析错误或无法解析的情况。因此,请参与编撰 C1 Wiki 的同学尽量严格遵守这些规范。
想到啥写啥,不定期更新。
常见问题及规范方法¶
关于中英文标点问题¶
实测发现,由于中英文半角全角问题,会导致英文符号在 C1 Wiki 中显示非常奇怪。因此,请尽量避免在中文语境中用英文的逗号和句号,这会使整体观感很奇怪。
关于 HTML 语法问题¶
C1 Wiki 的 Markdown 解析器对于一部分 HTML 语法不支持,而且可能造成解析错误或解析遗漏。因此,在 Markdown 文本中因尽量少用或不用 HTML 的语法。
关于文件名¶
对于文件名,有如下要求:
- 全部由英文小写字母和连字符
-
(即键盘上的减号)构成 - 不允许有空格
- 不允许有任何奇怪的标点,例如英文的撇号
’
(apostrophe)等
以上是格式要求。
此外,标题因尽量简洁明了,不要太冗长。尽量中译英,可以显得高大上一点。当然如果中译英实在太难也可以用拼音(例如奠基法)。
关于句内 Markdown 语法¶
很神奇的一点是,有时候在行内使用 Markdown 的着重符号等语法时,C1 Wiki 的解析器会解析不出来。目前没调出来是什么 bug,挺奇妙的。为了尽量避免,最好在两侧加上空格。例如:
包括超链接语法:
关于场景对话¶
为了是文章层次更清晰,我们可能会使用引用语法来突出一部分内容。但是因为显示效果不佳,我们考虑使用 Mkdocs 语法来替代。
例如,如果你想描绘一段对话,你可以这样实现:
场景
刘总跳小苹果。 同学们鼓掌。 董老师唱歌。 同学们鼓掌。
关于图床¶
请使用 GitHub 自带的 Upload Files 的功能,不要另找图床上传图片。否则不但可能网站无法解析,那个图床指不定哪天崩了那所有图片都没了(别问我我怎么知道的)。
关于标题级别¶
默认情况下,C1 Wiki 正文页面的标题解析方式是:
- 一级标题:特殊对待,将同时作为文章标题和网页标题。因此,一个页面上不允许出现两个一级标题。
- 二~六级标题:常规对待,按需使用。