4 ms·
Yes and no. Description lists are just a semantic distinction and Markdown’s goal is to be readable in its raw form. This is a description list in Markdown: -
by thiht 4y ago
Yes and no. Description lists are just a semantic distinction and Markdown’s goal is to be readable in its raw form. This is a description list in Markdown:
- word: definition
Or
- *word*: definition
It’s perfectly readable and conveys the intent of a description list. I wish Markdown parsers would generate a <dl> for styling purpose but it’s not a blocking point
- starkparker 4y ago> Description lists are just a semantic distinction So are *bold* and _emphasis_, but that doesn't mean they don't carry value. Aside from that, a definition/description list is more like: - term 1. first definition 1. second definition - first term - second term 1. definition vs. the KramDown implementation that GitHub once used for a description list: term : first definition : second definition first term second term : definition And KramDown's output was specific to the definition list case (and still calls them "definition lists" and not "description lists") by bolding the terms and indenting but not bulleting the definitions. Multiple terms are associated with the same item in a definition list, but separate items in an unordered list. Since this is in the context of GFM, which exists primarily to render Markdown on GitHub, the output behavior is arguably more significant than the input readability.