Watch 759 Star 1.2K Fork 337

开源中国 / Gitee FeedbackRuby

请支持Markdown [TOC] 标记

需求
意向
苏沫予  Opened this issue

需求说明

建议 markdown 支持 [TOC] 或者其他有效的自动目录设计

需求目的(解决什么痛点,带来什么收益)

gitee 帮助文档中以 [TOC] 非标为由拒绝支持自动目录,然而这个理由是不成立的(后面会详细说明)。

只要稍微长一点的 README,目录对于阅读者而言是非常有的效率

而 [TOC] 对于有目录需要的 markdown 编写者同样也是有极大效率提升的

关于所谓“标准”

使用 A 标签也是非标的,因为原生 Markdown 根本就没有定义过内链标签,而且 A 标签需要依靠自己写脚本或者完全人工维护,非常不方便

用户的不便当然可以用户自己解决,但是这也是产品设计可以认真设计的东西

markdown 没有严格的所谓“标准”,只有一份大家自愿遵守的创始人标准:

https://daringfireball.net/projects/markdown/syntax

对比这个“标准”,几乎所有社区实现都是超纲的,例如各种社区实现普遍支持的表格语法:

title0 | title1
-------|-------
cell0  | cell1
cell0  | cell1
title0 title1
cell0 cell1
cell0 cell1

在 John Gruber 原始设计中是要求用内联 HTML 标签实现的

需求来源

作为用户的我自己

+1 1
Attachments
total 1 participants

Comments (0)

Sign in to comment

Assignees
Labels
Not set
Projects
Milestones
Branches
Planed to start
Not set
Planed to end
Not set
Top level
Priority
Ruby
1
https://gitee.com/oschina/git-osc.git
git@gitee.com:oschina/git-osc.git
oschina
git-osc
Gitee Feedback

Help Search