Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Markdown lists do not interrupt paragraphs #11249

Closed
jayschwa opened this issue May 12, 2015 · 5 comments
Closed

Markdown lists do not interrupt paragraphs #11249

jayschwa opened this issue May 12, 2015 · 5 comments
Assignees
@MikeInnes
Labels
docsystem The documentation building system

Comments

@jayschwa
Copy link
Member

In most Markdown implementations I've used

My List:
* Item 1
* Item 2

renders as

My List:

  • Item 1
  • Item 2

However, doing that in a @doc string displays as

My List: * Item 1 * Item 2

The CommonMark spec says that no blank lines should be required between a paragraph and list.

Blockquotes do seem to interrupt paragraphs, so maybe that's a lead on how to do the same for lists.
@IainNZ
Copy link
Member

IainNZ commented May 12, 2015

Definitely a nice detail - StackOverflow requires a blank line, and its quite annoying.

@MikeInnes MikeInnes self-assigned this May 12, 2015
@jiahao jiahao added the docs This change adds or pertains to documentation label May 15, 2015
@quinnj quinnj added docsystem The documentation building system and removed docs This change adds or pertains to documentation labels Jun 28, 2015
@jakebolewski
Copy link
Member

CrossRef #12936

@MichaelHatherly MichaelHatherly mentioned this issue Jul 10, 2016
Merged
@StefanKarpinski
Copy link
Member

@MichaelHatherly: is this fixed?

MichaelHatherly added a commit to MichaelHatherly/julia that referenced this issue Aug 24, 2016
@MichaelHatherly
Don't require blank line before markdown lists
d8da082 
Fixes JuliaLang#11249 to follow the CommonMark spec for lists which does not
require a blank line prior to the start of a list.
@MichaelHatherly MichaelHatherly mentioned this issue Aug 24, 2016
Merged
@MichaelHatherly
Copy link
Member

is this fixed?

Yes :)

@KristofferC
Copy link
Member

Not merged yet. Will be auto closed when the PR is merged.

@KristofferC KristofferC reopened this Aug 25, 2016
mfasi pushed a commit to mfasi/julia that referenced this issue Sep 5, 2016
@MichaelHatherly @mfasi
Don't require blank line before markdown lists
83e7a5c 
Fixes JuliaLang#11249 to follow the CommonMark spec for lists which does not
require a blank line prior to the start of a list.
tkelman pushed a commit that referenced this issue Sep 16, 2016
@MichaelHatherly @tkelman
Don't require blank line before markdown lists
b9ec73c 
Fixes #11249 to follow the CommonMark spec for lists which does not
require a blank line prior to the start of a list.

(cherry picked from commit d8da082)
ref #18229
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MikeInnes MikeInnes

Labels
docsystem The documentation building system
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
9 participants
@jiahao @StefanKarpinski @jayschwa @IainNZ @jakebolewski @KristofferC @MikeInnes @quinnj @MichaelHatherly