search

valeriangalliat / markdown-it-anchor

A markdown-it plugin that adds an `id` attribute to headings and optionally permalinks.
The Unlicense
291 stars 72 forks source link

Missing #todo-anchor-or-file header in README #123

Closed rendall closed 1 year ago

rendall commented 1 year ago

When building, I get this warning:

(node:40066) Warning: Using deprecated markdown-it-anchor permalink option,
see https://github.com/valeriangalliat/markdown-it-anchor#todo-anchor-or-file`

That is not the issue I want to report, though. I'm submitting this particular issue because the #todo-anchor-or-file does not have a link that describes the warning.

I recommend either having the #todo-anchor-or-file heading in the README or updating the warning if possible to a working link.

Thank you for this project! 🥇

valeriangalliat commented 1 year ago

Thanks for reporting! The proper link is https://github.com/valeriangalliat/markdown-it-anchor#permalinks, I updated the package to reflect this 🙏