README markdown is strictly incorrect
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 60/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- markdown
- Domain
- documentation
Research direction
Review the README's fenced code blocks and preview the document in a strict Markdown reader such as Byword. Ensure each code block is separated from preceding text by a blank line, then confirm the rendering remains unchanged on GitHub and is clearer in the strict reader.
Written by the indexing model from the issue text.
Description
Describe the bug
The GitHub markdown display is friendly, so the error doesn't appear here, but in some other markdown readers, the README file presents incorrectly. Block quotes of code should be prefaced with an empty line, otherwise to a strict interpreter, it is wrapping around on the above line.
To Reproduce
Opening the file in the Byword app is one way to reproduce this problem.
File->Preview Markdown will display the rendered document.
The code blocks are much less clear to read.
Expected behavior
Just adding a blank line before the code blocks with three back quote characters should not change it's display here and will correct its display for others.
Environment
- Device: MacBook Pro ,
- OS: Sequoia 15.3
- Markdown Renderer: Byword 2.9.6 (6499)
- Dominant language
- Objective-C
- Stars
- 2k
- Forks
- 867
- Avg merge
- 4d 48m
- Merged PRs (30d)
- 1
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from openid/AppAuth-iOS
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
openid/AppAuth-iOS#962 ·
-
enhancement triage
Difficulty 4/5 3-5 days Newbie friendliness 38/100
openid/AppAuth-iOS#953 ·
-
enhancement triage
Difficulty 4/5 3-5 days Newbie friendliness 45/100
openid/AppAuth-iOS#948 ·
-
bug
Difficulty 4/5 3-5 days Newbie friendliness 35/100
openid/AppAuth-iOS#932 · 1 comment ·
-
enhancement triage
Difficulty 4/5 3-5 days Newbie friendliness 35/100
openid/AppAuth-iOS#928 · 3 reactions ·
All issues in openid/AppAuth-iOS
Similar issues
-
clawsweeper:source-repro impact:other issue-rating: 🦞 diamond lobster P2
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
openclaw/openclaw-facetime#40 · 2 comments · 1 reaction ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
noah-nuebling/mac-mouse-fix#2054 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
obsproject/obs-studio#13918 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
SwiftOldDriver/iOS-Weekly#5439 · 1 comment ·