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.

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

Bullet lists swallow callouts #785

Closed
reitzig opened this issue Apr 26, 2017 · 1 comment · Fixed by #1135
Closed

Bullet lists swallow callouts #785

reitzig opened this issue Apr 26, 2017 · 1 comment · Fixed by #1135
Labels

Comments

@reitzig
Copy link

reitzig commented Apr 26, 2017

I expect code like this:

/**
    Some description with

     * one and
     * two items.

    - Note: Be careful! 
    - Precondition: The given string has at least three characters.
*/

to create a paragraph with a list and then two notes (on the top level). However, Jazzy creates this:

<p>Some description with</p>
<p></p><li><p>one and</p></li>
<li><p>two items.</p>
<div class="aside aside-note">
    <p class="aside-title">Note</p>
    Be careful! <p></p>

<p></p></div>
<div class="aside aside-precondition">
    <p class="aside-title">Precondition</p>
    The given string has at least three characters.<p></p>

<p></p></div></li>

The last list item swallows the callouts, which can cause weird formatting, e.g. if you indent lists.
Note how also the <ul> tag is missing.

Also, there are lots of spurious <p> tags.

Workaround: Insert <!-- something --> before the callout.

@johnfairh
Copy link
Collaborator

The indentation used here (one more space before * than -) makes redcarpet (somewhat unexpectedly) treat the - list as a sublist of the * list. This is why the last </li> is in the wrong place.

The regular list gets merged with the callouts, which causes the <ul> tags to get dropped, due to jazzy's creation of the callouts. This part is fixable in jazzy.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants