[Markdown] Table within list doesn't render correctly

[ajeetdsouza]

In the README of my crate, a Markdown table placed under a list element doesn't render correctly, even with the correct indentation. This works fine on GitHub, and it would be nice if crates.io was able to support this too.

For context, look at the Environment Variables section in both of these:

• GitHub README: https://github.com/ajeetdsouza/zoxide#environment-variables
• crates.io README: https://crates.io/crates/zoxide

---

The following is an example of a table within a list in Markdown:

- Root 1
  - Item 1
  - Item 2:
    | OS          | Path                                     | Example                                    |
    | ----------- | ---------------------------------------- | ------------------------------------------ |
    | Linux / BSD | `$XDG_DATA_HOME` or `$HOME/.local/share` | `/home/alice/.local/share`                 |
    | macOS       | `$HOME/Library/Application Support`      | `/Users/Alice/Library/Application Support` |
    | Windows     | `{FOLDERID_RoamingAppData}`              | `C:\Users\Alice\AppData\Roaming`           |

It should render this way:

• Root 1
  • Item 1
  • Item 2:

    OS	Path	Example
    Linux / BSD	$XDG_DATA_HOME or $HOME/.local/share	/home/alice/.local/share
    macOS	$HOME/Library/Application Support	/Users/Alice/Library/Application Support
    Windows	{FOLDERID_RoamingAppData}	C:\Users\Alice\AppData\Roaming

[plaets]

Looks like this could be a bug in comrak, the markdown library used by crates.io.

You can test this by installing comrak using cargo install comrak and then running something like
cat README.md | comrak -e autolink -e strikethrough -e table -e tagfilter -e tasklist --unsafe --header-ids user-content-
to manually render your readme to html (options from src/render.rs). The relevant part of the result should look like this

Full output here

If you want a temporary fix, adding a newline between the list element and the table seems to work. Although it looks like it also slightly changes the formatting.
fixed readme

[ajeetdsouza]

@plaets thanks for the quick reply, I've created an issue here: kivikakk/comrak#182.

[kivikakk]

Hi! I've released 0.10.1-rc.1 which fixes this issue. Sorry for the rc but I just don't have the time for a full release right now. This specifically fixes this issue, per the same change made in upstream cmark-gfm.