之前码云的解析器基于用户的反馈做了很多定制化的修改。
但是随着使用码云的用户越来越多,以及越来越多的Github用户往码云上迁移,我们收到了很多用户反馈。
始料不及,在Github正常解析渲染的Readme在码云上渲染出来的结果却有所出入。
讨论再三,我们决定将码云的 Markdown 解析器更换为 CommonMark。
更改后的差异如下。
01
标题#后面需要有空格才会正确渲染标题
02
正确解析形如 Map<String, Collection<Object.toString>> 的文本
03
解决代码块标签前后没有空行导致不换行显示
04
解决Readme中注释显示的问题
05
解决 Html colspan、rowspan 标签无效的问题
06
解决标题中不支持Code块的问题
07
解决内容中不留空格无法加粗的问题
08
支持--构建表格
09
不再支持[TOC]
标准的Markdown是不支持[TOC]标签的,可以通过a标签的方式自行创建目录。
码云上Readme后缀说明
码云为了适应不同种类的开源项目的Readme显示,有不同的优先显示规则,如下:
- 如一个项目有Readme.osc.md 也有 Readme.md,那么在码云上则优先显示 Readme.osc.md
- 再比如一个项目有Readme.zh-CN.md 又有 Readme.en.md 如果浏览器是英文,则显示Readme.en.md,如果浏览器是中文,则显示 Readme.zh-CN.md
具体规则如下:
- 有osc标示优先 如Readme.osc.md
- 其次对应语言优先 简体中文[zh CH cn zh-cn zh_cn] 繁体中文 [zh-hk zh-tw zh-yue zh_hk zh_tw zh_yue] 英文 [en] 如 Readme.zh.md
- 没有以上规则以后缀优先 [mdown md mkdn mdwn markdown textile rdoc creole mediawiki rst rest adoc asciidoc pod org txt html htm] 如readme.mdown
- 如果您在使用中遇到问题,欢迎反馈 :
https://gitee.com/oschina/git-osc/issues/new
- 附 CommonMark 语法文档 :
http://commonmark.org/help/