thoughtbot / guides

A guide for programming in style.

Home Page:https://thoughtbot.com/playbook

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Data guide should use description lists

WilHall opened this issue · comments

The data guide has a section of definitions as markdown.

The content would be more accessible and visually appealing if it used definition lists for outlining the terms.

Do you want to preserve the markdown version as well as have a version that uses HTML? AFAIK, HTML doesn't render in GitHub, but I did find this. Were you imagining something like this being used in lieu of a markdown file?

You should be able to render most HTML inline with markdown.

For example, here is a description list:

Beast of Bodmin
A large feline inhabiting Bodmin Moor.
Morgawr
A sea serpent.
Owlman
A giant owl-like creature.

Source:

<dl>
    <dt>Beast of Bodmin</dt>
    <dd>A large feline inhabiting Bodmin Moor.</dd>
    <dt>Morgawr</dt>
    <dd>A sea serpent.</dd>
    <dt>Owlman</dt>
    <dd>A giant owl-like creature.</dd>
</dl>

Oh nice. TIL. Thanks :)