Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for <details> and <summary> #1287

Open
BurdetteLamar opened this issue Feb 5, 2025 · 1 comment
Open

Support for <details> and <summary> #1287

BurdetteLamar opened this issue Feb 5, 2025 · 1 comment

Comments

@BurdetteLamar
Copy link
Member

BurdetteLamar commented Feb 5, 2025

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.

@olleolleolle
Copy link
Contributor

(I edited the links to descriptions of summary and small elements so that they render clearer here.)

MDN pages about same elements:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

2 participants