Common syntax for abbreviations

[kimburgess]

Rather than defaulting to inline HTML <abbr> tags, it would be nice to define a common syntax for usage within doc content, which the parser will then transform to these.

A good option for this looks to be via remark-abbr.

This will also allow these to be checked via the the linter, rather than needing to add exception, or a blanket ignore rule.

Originally from #29 (comment)

[mghill]

Current thought on this: I think given our other choices for relatively-universal compatibility for display, just going with manual tags on the first instance of an acronym on a page could be our best bet. The remark-abbr is neat, and probably more friendly for our specific intended use, but only renders okay without the plugin. What's your thought?

Point back against: the <abbr> tags run afoul of #27 as the linter treats them like words in some instances. I'm back onside for remark-abbr

[kimburgess]

Don't let bugs / limitations in linter config influence writing style. Anything that pops up there can be fixed (and ignored until then).

That being said, I do quite like the remark-abbr syntax. Using it seems inline with other decisions around keeping things markdown-esque (tabs annotations etc). It will also rewrite all occurrences in the doc to be wrapped in <abbr> elements.

[mghill]

Honestly I think I was still up in the air on this, rather than the linter changing my mind, it just made me look at it again. I like universal compatibility, but the endnote syntax is very unobtrusive and better in the long term.