errata-ai / Google

A Vale-compatible implementation of the Google Developer Documentation Style Guide.
MIT License
69 stars 23 forks source link

Possible to have Acronyms understand abbreviations? #19

Open LukeCarrier opened 1 year ago

LukeCarrier commented 1 year ago

Thanks for Vale and these awesome rules -- it's an awesome tool!

I'm working on configuring Vale to support technical documentation where TLAs (three letter abbreviations) are everywhere. To help contextualise them even if folks are skipping introductory sections I find using <abbr> (or the Markdown equivalent of *[TLA]: Three Letter Abbreviations) is useful, as it'll show all instances of the abbreviation in some formatting that'll nudge the user to hover over the text for a tooltip spelling it out.

I've noticed that Vale doesn't currently understand this syntax and I'm not sure on how to implement it in a way that supports multiple markup syntaxes. If you'd be able to give me some pointers I'd gladly have a go at implementing this?