README markdown syntax error with `<details>`
lilyball opened this issue · comments
Lily Ballard commented
In your README, you use <details>
in a few places, and the contents of the expando are not parsed for markdown syntax. This can make those contents hard to read. This is because Markdown stops parsing when it encounters a block HTML tag, as it assumes you've just pasted some raw HTML in there.
You can work around this by adding blank lines inside of the tag. By moving the contents of the tag to a separate paragraph, Markdown resumes parsing.
This would look like
<details>
Contents go *here*.
</details>
Example:
Contents go here.
or
<details><summary>Example:</summary>
Contents go *here*.
</details>
Example:
Contents go here.
Michael Färber commented
Thanks for pointing this out! It is indeed much easier to read now. :)