From 9b0778444b6cba8bc64e24521fbf7a669bc23bc6 Mon Sep 17 00:00:00 2001 From: "Xunnamius (Romulus)" Date: Fri, 21 Oct 2022 17:49:43 -0700 Subject: [PATCH] fix(readme.md): make introduction more helpful --- packages/remark-renumber-references/README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/packages/remark-renumber-references/README.md b/packages/remark-renumber-references/README.md index 52badd4..1ac7576 100644 --- a/packages/remark-renumber-references/README.md +++ b/packages/remark-renumber-references/README.md @@ -23,11 +23,12 @@ plays nicely with [GFM footnotes][6] (by completely ignoring them). After running this plugin, _all definitions_, both numeric and alphanumeric, will always be placed at the very bottom of the document. -You might also be interested in [remark-reference-links][2], which transforms -all your inline links into reference-style links, and +**This plugin is a drop-in replacement for [remark-reference-links][2].** If you +want to preserve some inline links (e.g. for generated content), check out +[remark-ignore][7]. You might also be interested in [remark-sort-definitions][3], which will logically reorder the reference definitions at the bottom of your document. For a live example of these plugins -in action, check the bottom of [this very README.md file][25]. ✨ +in action, check the source of [this very README.md file][25]. ✨ --- @@ -407,3 +408,4 @@ information. [4]: /.remarkrc.mjs [5]: /packages/remark-remove-unused-definitions [6]: https://github.com/remarkjs/remark-gfm#what-is-this +[7]: /packages/remark-ignore/