Consistent reference documentation
Closed this issue · 0 comments
adamschwartz commented
We’re working towards standardizing a design for reference documentation for code.
The current thinking is that much of the heavy lifting can be handled by simple definition lists, which is supported by a number of Markdown supersets using the following syntax:
Coffee
: Black hot drink
Milk
: White cold drink
Becomes:
<dl>
<dt>Coffee</dt>
<dd>Black hot drink</dd>
<dt>Milk</dt>
<dd>White cold drink</dd>
</dl>
In our case, we’d be typically using an inline code element inside the description term element, so something like this:
`method()`
: Description of how `method` works.