Support for <details> and <summary>
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue targets RDoc’s HTML documentation output; start by locating the renderer for inline markup and existing HTML tag support. Confirm rendering for details/summary, or the small fallback, with embedded bold, italic, and monospaced text, then add coverage showing the requested output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100