Fix terminology rendering regression. #97
Merged
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
nathan-at-least
force-pushed
the
fix-terminology-reversion
branch
from
897148e to
11f49a0
Compare
daira
reviewed
Oct 25, 2023
| @@ -6,42 +6,45 @@ Definitions are sorted alphabetically. | |||
|
|
|||
| ## Terms | |||
|
|
|||
| <span id="definition-assured-finality">**Assured Finality**</span>: A protocol property that assures that transactions cannot be reverted by that protocol. As with all protocol guarantees, a protocol assumes certain conditions must be met. A transaction may either be final or not: transactions which are not final may not become final, whereas once transactions do achieve finality they retain that property indefinitely (so long as protocol requirements are met). | |||
| <!-- Unlike true html, it seems `mdbook` requires the span tags to be empty and immediately pre-fix the intended anchor target. --> | |||
There was a problem hiding this comment.
mdbook is actually doing the Right Thing, and I should have realised it. The "**" markup is used for bold text in Markdown, but has no special meaning in HTML. An HTML container (such as span) embedded in Markdown should have its contents parsed as the Markdown-supported subset of HTML, not as Markdown. Therefore the rendering with non-bold **Assured Finality**, etc. is correct. You would need <span id="definition-assured-finality"><b>Assured Finality</b></span> (or <strong>, I'm not exactly sure which tags are supported) to get bold text within a span. In any case this is fine for now. I will fix the comment in my next PR.
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.
<span>tags.Remove a large(← force pushed this change out because I understand it's necessity now to ensure correct position scrolling for terminology.)<pre>block full of whitespace.<pre>block of whitespace and the empty<span>tags since each are non-obvious.In #92 we used
<span>tags as would seem correct for html, placing the term-to-be-defined within the<span>tags. Here's an example of such a change.However, for some reason, that breaks
mdbookrendering. (Maybe the parser is literally only accepting<span …></span>?)The broken rendering is on the current public url and looks like this:
By reverting this change and making the span tags contain nothing, but immediately prefix the terms-to-be-defined, both the rendering and navigation appear correct both in my local rendering and previous public URL renderings:
