Support for <details> and <summary>
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 42/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- ruby
调研方向
该 issue 针对 RDoc 的 HTML 文档输出;首先定位用于内联标记的 renderer 以及现有的 HTML 标签支持。确认 details/summary(或小型 fallback)在嵌入粗体、斜体和等宽文本时的渲染,然后添加展示所需输出的 coverage。
由索引模型根据 Issue 内容生成。
描述
Over at ruby/ruby, we sometimes have a situation in documentation where certain details may or may not be important to a few readers, but will be irrelevant to many.
E.g., @peterzhu2118 and I are looking at "Hash Equality and Inclusion", whose details may be important to a few but will be irrelevant to many. One of us thinks that info should be at a link; the other thinks it should be included inline.
There may be many other such.
Casting that info as <details><summmary>...</summary>...</details> would be a perfect solution. See <summary>.
Failing that, a weaker alternative would be support for <small>; see <small>.
In either case, support for embedded bold would be important (to give structure without adding headings), along with italic and monofont.
- 主要语言
- Ruby
- 星标
- 930
- 派生
- 465
- 平均合并
- 2 天 16 小时
- 30 天内合并 PR
- 28
环境准备
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
ruby/rdoc 的其他 Issue
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentation未关闭
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 85/100
维护者通常 1 天内回复
-
enhancement
难度 4/5 3-5 天 新手友好度 68/100
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 68/100
维护者通常 1 天内回复
-
难度 5/5 一周以上 新手友好度 35/100
维护者通常 1 天内回复
相似的 Issue
-
area/web interface
难度 2/5 1-3 小时 新手友好度 65/100
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 90/100
chef/mixlib-shellout#287 ·
-
难度 2/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 86/100
-
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复