README markdown is strictly incorrect
Nobody has claimed this yet.
- Dominant language
- Objective-C
- Stars
- 2k
- Forks
- 867
- Avg merge
- 4d 48m
- Merged PRs (30d)
- 1
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)
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.
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.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 60/100