Skip to content

Commit

Permalink
fix(readme.md): make introduction more helpful
Browse files Browse the repository at this point in the history
  • Loading branch information
Xunnamius committed Oct 22, 2022
1 parent 8642f3b commit 9b07784
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions packages/remark-renumber-references/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]. ✨

---

Expand Down Expand Up @@ -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/

0 comments on commit 9b07784

Please sign in to comment.