showdown/paragraphed-list-with-sublists.md at 25f19786665450f3e7506f99b698283516ec03c8 - showdown - Kiritow Git Site

StarMirror/showdown

mirror of https://github.com/showdownjs/showdown.git synced 2024-03-22 13:30:55 +08:00

Estevao Soares dos Santos d51be6e0b4 fix(lists): enforce 4 space indentation in sublists

Acording to the spec, multi paragraph (or block) list item requires subblocks
to be indented 4 spaces (or 1 tab). Although, this is mentioned in the documentation,
Showdown didn't enforce this rule in sublists because other implementations,
such as GFM also didn't. However, in some edge cases, this led to inconsistent behavior,
as shown in issue #299. This commit makes 4 space indentation in sublists
mandatory.

BREAKING CHANGE: syntax for sublists is more restrictive. Before, sublists SHOULD be
indented by 4 spaces, but indenting 2 spaces would work. Now, sublists MUST be
indented 4 spaces or they won't work.

With this input:
```md
* one
  * two
    * three
```

Before (ouput):
```html
<ul>
  <li>one
    <ul>
      <li>two
        <ul><li>three</li></ul>
      <li>
    </ul>
  </li>
<ul>
```

After (output):
```html
<ul>
  <li>one</li>
  <li>two
    <ul><li>three</li></ul>
  </li>
</ul>
```

To migrate either fix source md files or activate the option `disableForced4SpacesIndentedSublists` (coming in v1.5.0):

```md
showdown.setOption('disableForced4SpacesIndentedSublists', true);
```

2016-11-11 07:56:29 +00:00

14 lines

102 B

Markdown

Raw Blame History

  - foo
     - bazinga
     - yeah
  - bar
 . damn
 . so many paragraphs
  - baz