refactor: Use a custom autoref HTML tag #48
Merged
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 changes the HTML tags used for auto-references from
span
to a customautoref
tag. This is made backward compatible by regex-replacing using both the old regex and the new one. The new regex is much, much simpler. Additional HTML attributes are parsed with a proper HTML parser, so ordering does not matter anymore.Transition period:
span
s in their templates and/or docs.autoref
HTML tag, settingAutorefsPlugin.legacy_refs
toFalse
to disable legacy refs (no perf loss). Handlers will require the new version of mkdocs-autorefs in their dependencies.AutorefsPlugin.legacy_refs
will be warned by type-checkers that thislegacy_refs
attribute does not exist anymore. At runtime, it will have no effect.