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

Option to have remark-abbr substitute definition for first occurrence. #304

Closed
roxspring opened this issue Dec 12, 2018 · 3 comments
Closed
Labels
misc/help wanted This issue needs help type/request This is great to have

Comments

@roxspring
Copy link
Contributor

In written documents, it's common for the first occurrence of an abbreviation to be introduced with the definition first followed by the abbreviation in brackets. It would be great if the remark-abbr plugin could optionally do this. e.g.

This plugin works on MDAST.

More stuff about MDAST.

*[MDAST]: Markdown Abstract Syntax Tree

Would translate to:

<p>This plugin works on Markdown Abstract Syntax Tree (MDAST).</p>

<p>More stuff about <abbr title="Markdown Abstract Syntax Tree">MDAST</abbr>.</p>

This would be especially great for workflows where documents are being composed of multiple markdown files and it's not immediately obvious which file will be introducing a given abbreviation first.

@vhf vhf added type/request This is great to have misc/help wanted This issue needs help labels Dec 23, 2018
@vhf
Copy link
Contributor

vhf commented Dec 23, 2018

@roxspring I like this idea. Would you be interested in implementing it?

@roxspring
Copy link
Contributor Author

Sure. Will aim to give it a try soon.

@artragis
Copy link
Member

Is it ok here?

@vhf vhf closed this as completed Apr 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
misc/help wanted This issue needs help type/request This is great to have
Projects
None yet
Development

No branches or pull requests

3 participants