Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Possible to have Acronyms understand abbreviations? #19

Open
LukeCarrier opened this issue Jul 26, 2022 · 0 comments
Open

Possible to have Acronyms understand abbreviations? #19

LukeCarrier opened this issue Jul 26, 2022 · 0 comments

Comments

@LukeCarrier
Copy link

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant