趣记博客 教程技术 GitHub仓库显示Markdown

GitHub仓库显示Markdown

image.png

许多 Markdown 生成器都有 TOC(大纲)功能,将文章的标题提取出来,做成一个带有 HTML 元素 id 的链接清单,点击后就会跳转到对应标题的位置。

仓库显示Markdown

由于 CommonMark 没有规定过 TOC 功能,自然各种 Markdown 生成器对此有不同的策略,有的直接照搬,将标题内容转化为 HTML 元素 id,有的将大写字母转为了小写,还有的仅保留 ASCII,并将空格替换为短横线,总之这个 TOC 功能,在各个 Markdown 生成器里各不相同,要实现「一次编写,到处运行」,还有很远的路。


GitHub 默认不把 Markdown 记入统计,所以你的文本仓库,很可能被 CSS, yaml 等文件抢了风头。所以要成为真正的 Markdown 工程师,应该在仓库里添加一个文件 .gitattributes,内容为:

.md linguist-detectable=true
.md linguist-documentation=false

这样就会像标题图,Alexandre Sanlim 的 GitHub 主页一样,出现 Markdown 编写的仓库了。

本文来自网络,不代表趣记博客立场,转载请注明出处:https://www.quji.org/archives/5961
image.png

作者: 我爱喝可乐

喜欢摄影,喜欢看电影和搞黄色。喜欢和喜欢的人(男女不限)讨论有深度的话题,有点中二病。

发表回复

您的电子邮箱地址不会被公开。 必填项已用*标注

返回顶部