Update docs about list indentation #752
Conversation
docs/index.md
Outdated
| @@ -91,7 +92,9 @@ are summarized below: | |||
| In the event that one would prefer different behavior, | |||
| [tab_length](reference.md#tab_length) can be set to whatever length is | |||
| desired. Be warned however, as this will affect indentation for all aspects | |||
| of the syntax (including root level code blocks). | |||
| of the syntax (including root level code blocks). Alternatively, you could | |||
| use the [mdx_truly_sane_lists](https://github.com/radude/mdx_truly_sane_lists) | |||
There was a problem hiding this comment.
While I understand the spirit of this change, I'd rather not favor any one third-party extension over another. Instead, this link should point to the wiki page where we keep a list of all known third party extensions. Perhaps one of them will meet the users needs.
And that list is publicly editable, so if you see an extension is missing, feel free to add it yourself.
docs/index.md
Outdated
| @@ -80,7 +80,8 @@ are summarized below: | |||
| The [syntax rules](http://daringfireball.net/projects/markdown/syntax#list) | |||
| clearly state that when a list item consists of multiple paragraphs, "each | |||
| subsequent paragraph in a list item **must** be indented by either 4 spaces | |||
| or one tab" (emphasis added). However, many implementations do not enforce | |||
| or one tab" (emphasis added). However, many implementations – including the | |||
| original markdown.pl implementation itself – do not enforce | |||
There was a problem hiding this comment.
I see no value in adding this. Lets leave it out.
There was a problem hiding this comment.
People should be searching old issues before opening a new issue, in which case they would know that. I realize GitHub doesn't search closed issues by default, but we call this out in our (new) contributing guide. If people follow the guide, then this is a non-issue.
There was a problem hiding this comment.
People don't. I know, because I didn't (until afterwards).
waylan
added
docs
As per the guide, we should only fix the area we are working on, so we leave the rest of the document as is, but follow the guide with our change and use a reference style link with the reference at the end of the document. Also, remove unhelpful comment.
|
It was worth a try! Thanks for your time! 🎉 |
No description provided.