gjtorikian / gjtorikian/markdowntutorial.com

Explain that lists and bullets require empty line before

Open
#46 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
606
Forks
131
PR merge metrics
No merged PRs in 30d

Description

When using markdown in the real world, one common and frustrating issue when using bullets and lists is that a blank line is not left before the list - this causes them to fail to render correctly.

For lesson 6, it would be valuable to explain this as well as have an exercise to test this much needed markdown knowledge.

Example which doesn't render

Markdown:

Here are your bullets, sir:
- Lead
- Jacketed lead
- Hard Cast
- Blank

Rendered markdown:

image

Example which renders

Markdown:

Here are your bullets, sir:

- Lead
- Jacketed lead
- Hard Cast
- Blank

Rendered Markdown:

image

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open lesson 6 at http://markdowntutorial.com/lesson/6/ and review how its Markdown explanation and exercise are structured. Add the missing guidance that lists and bullets need a preceding blank line, along with an exercise covering both examples. Done means lesson 6 clearly explains the rendering difference and tests this knowledge.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.