Docs: improve formatting of markup description
- Place attributes and convenience tags into lists to avoid a text wall.
- Add headings for each list
- Fix broken colour specifications (e.g. #FF0000 had lost the '#')
- Fix broken |piped| monospace sections
-
backticks
rather than 'quotes'
I couldn't find much in the way of guidelines for formatting, so I hope it's OK. I really wanted a <variablelist>
, but I couldn't figure out how to do that natively in Markdown, and commits like this made me think maybe the Markdown parser doesn't handle them, so I just used an unordered list. It looks like I can just place <variablelist>
in the Markdown, but unsure if that's good practice, or if deprecated.
The #GMarkup
link is also broken, but I'm not sure if a cross-lib link is even possible.
Edited by John Beard