Use reference links in Markdown. #1025
Closed
+73
−40
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This can dramatically reduces the volume of markdown. Fixes #948.
This approach might be problematic when inserting markdown under a readme heading if the readme already has link references with conflicting IDs.
One option might be to use a customizable prefix for the numeric link IDs to act as a namespace. Perhaps using the insertion heading string by default?
For the record, I did try remark-defsplit but chose not to use it:
What seems like a good idea for an alternative, is a Remark plugin that creates references based on short hashes of the URI being referenced. That way, you only need to worry that the bookmark IDs being linked are document-unique, which is something that needs to happen regardless.