Editorial: Update note markup/markdown and styling #404
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
|
Hey @marcoscaceres - I know bikeshed isn't your normal jam, but maybe you could take a look at this? (Not urgent at all.) |
Using the `note: ...` markdown, Bikeshed produces nicely styled notes with a "NOTE:" prefix automagically generated. This source was not using that, so not getting the nice prefix. Fix that! * `<aside>` was used for notes, examples, and advisements, but it's not a block element. Just use `<div>`. * For notes, use `NOTE:` markdown where possible (single paragraphs) * Otherwise, add "NOTE:" manually as a span, class=marker * For a handful of cases where a note follows an algorithm and references variables within the algorithm, scooch the note inside the algorithm's containing div so that it is autolinked. * Remove a stray unbalanced `</div>` See speced/bikeshed#2562 for context.
inexorabletash
requested review from
a-sully
and removed request for
marcoscaceres
|
@a-sully - could I trouble you for a review of this too? Thanks! |
a-sully
approved these changes
Aug 4, 2023
|
Thanks @a-sully ! |
github-actions bot
added a commit
that referenced
this pull request
Aug 4, 2023
SHA: 9b68115 Reason: push, by inexorabletash Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Closed
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.
Using the
note: ...markdown, Bikeshed produces nicely styled notes with a "NOTE:" prefix automagically generated. This source was not using that, so not getting the nice prefix. Fix that!<aside>was used for notes, examples, and advisements, but it's not a block element. Just use<div>.NOTE:markdown where possible (single paragraphs)</div>See speced/bikeshed#2562 for context.
Preview | Diff