Rework autorefs replacement to not re-parse the final HTML #188
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Define a "transport representation" for autorefs:
<span data-mkdocstrings-identifier="SomeIdentifier">SomeHTML</span>
First a native Markdown extension translates from the usual `[SomeMarkdown][SomeIdentifier]` to the above, and then the post-process replacement mechanism (which is kept in the same place as before) doesn't need to be so careful and complicated, it just indiscriminately replaces such exact strings.
This is a very big boost in performance and I think is more future-proof.
Other mkdocstrings handlers are also free to use this mechanism: define whatever syntax for autorefs that they need and then insert this exact HTML themselves, for the postprocessing to pick up later. It used to be possible to insert the square-brackets Markdown before, but that was very fragile.
|
Fixes #187. Compare the performance profile to what I posted there.
|
oprypin
added a commit
to mkdocstrings/crystal
that referenced
this pull request
Dec 6, 2020
oprypin
added a commit
to mkdocstrings/crystal
that referenced
this pull request
Dec 7, 2020
oprypin
added a commit
to oprypin/mkdocstrings
that referenced
this pull request
Dec 19, 2020
First introduced in mkdocstrings#188, there's a regression: if something messes with the final HTML before mkdocstrings plugin gets to it (as happens specifically with 'minify' plugin if it ever appears before our plugin in the config -- which it shouldn't anyway). So workaround this specific case. Make the attribute quotes optional to also catch minified HTML. Hard to do much else, though perhaps a warning would make sense.
oprypin
added a commit
to oprypin/mkdocstrings
that referenced
this pull request
Dec 19, 2020
First introduced in mkdocstrings#188, there's a regression: if something messes with the final HTML before mkdocstrings plugin gets to it, it can't be detected and replaced. A known case is with 'minify' plugin if it appears before our plugin in the config (which it shouldn't anyway). So workaround this specific case. Make the attribute quotes optional to also catch minified HTML. Hard to do much else, though perhaps a warning would make sense.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Define a "transport representation" for autorefs:
First a native Markdown extension translates from the usual
[SomeMarkdown][SomeIdentifier]to the above, and then the post-process replacement mechanism (which is kept in the same place as before) doesn't need to be so careful and complicated, it just indiscriminately replaces such exact strings.This is a very big boost in performance and I think is more future-proof.
Other mkdocstrings handlers are also free to use this mechanism: define whatever syntax for autorefs that they need and then insert this exact HTML themselves, for the postprocessing to pick up later. It used to be possible to insert the square-brackets Markdown before, but that was very fragile.
Fixes #187.