Make README more semantic. - #138
Open
beedell-roke wants to merge 1 commit into
Open
Conversation
- All inaccessible `<br/>`s (and the occasional, inconsistent usage of `<br />`s) have been replaced by real `p`s, so that they wrap as expected, and screen readers announce them. - The JSONC `pre > code` has had syntax highlighting enabled. - Some headings that erroneously lacked title case now utilise it (like “WebDAV”), and `rsync` has been codified. - Eastern Arabic numerals should be right-aligned, rather than centred (like Mandarin), so they have been. - `:is(ul, ol) li`s should always be spaced with a `\n`, else they do not wrap with a gap. This means that they'll appear different to your `p`s. Refer to the CommonMark (and GHFM) standards. - The JSON examples are block elements, so that they can be syntax-highlighted and easily duplicated into the clipboard.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
They're all very minor modifications:
All inaccessible
<br/>s (and the occasional, inconsistent usage of<br />s) have been replaced by realps, so that they wrap as expected, and screen readers announce them.>has been replaced by\>, so that it is more readable astext/plain.The JSONC
pre > codehas had syntax highlighting enabled.Some headings that erroneously lacked title case now utilise it (like “WebDAV”), and
rsynchas been codified.Eastern Arabic numerals should be right-aligned, rather than centred (like Mandarin), so they have been.
:is(ul, ol) lis should always be spaced with a\n, else they do not wrap with a gap. This means that they'll appear different to yourps. Refer to the CommonMark (and GHFM) standards.The JSON examples are block elements, so that they can be syntax-highlighted and easily duplicated into the clipboard.
In case this matters, because it appears to be a scourge nowadays, no LLMs were involved in this process whatsoever. Not that they'd need to be; it's mere markup.