我的收藏
    码云帮助中心 / 帮助详情

    码云文档协作Markdown 解析器变更

    之前码云的解析器基于用户的反馈做了很多定制化的修改,但是随着使用码云的用户越来越多,以及越来越多的 Github 用户往码云上迁移,我们收到了很多用户反馈,在 Github 正常解析渲染的 Readme 在码云上渲染出来的结果却有所出入,讨论再三,我们决定将码云的 Markdown 解析器更换为 CommonMark。

    更改后的差异如下:

    标题#后面需要有空格才会正确渲染标题

    标题

    正确解析形如 Map<String, Collection<Object.toString>> 的文本

    文本

    解决代码块标签前后没有空行导致不换行显示

    标签

    解决Readme中注释显示的问题

    注释

    解决 Html colspan、rowspan 标签无效的问题

    标签无效的问题

    解决标题中不支持 Code 块的问题

    Code 块

    解决内容中不留空格无法加粗的问题

    解决内容中不留空格无法加粗的问题

    支持--构建表格

    构建表格

    不再支持[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/。

    以上内容对你是否有帮助?

    搜索帮助