Update README formatting

Thanks for catching the missing indentations @jungle. I do prefer to use 1.'s in numbered lists, since it makes it simpler to maintain longer lists, so kind of a "best practice" in my opinion. It is also used in the README.md template → .

I created a new branch for easier previewing, and added a Merge Request, please review.

Hi, @ressa I would suggest to use `-`s instead of `1`s.

While users may read plain markdown, using '1's in the text may be confusing and inappropriate. The documentation that mentions this usage could be considered a false positive.

Hi @jungle, maybe we should keep it an ordered list, since these are steps, to be done in that order? But if you prefer 1. 2., etc. let's go for that :)

PS. Two more examples, where they prefer 1.'s:

• https://docs.gitlab.com/ee/development/documentation/styleguide/#choose-...
• https://docs.gitlab.com/ee/user/markdown.html#links

@ressa, I appreciate your examples and find them convincing. However, to avoid any confusion, would it be possible to add a note with a link to the documentation to indicate that is a best practice, another example in examples, right?

Thanks for taking the time to check out the Gitlab Markdown style guide @jungle.

Do you mean adding a new line to README.md template → , something like this?

• [...]
• Bulleted lists denoted by dashes (-)
• Ordered lists using 1.'s (for example, see Configuration → )
• Nested lists indented with 4 spaces
• [...]

+++ b/README.md
@@ -48,14 +48,14 @@ about how to use Composer with Drupal on
 

@ressa, I meant to append a note at the button of the README.md if you agree, e.g.:

Note: In this file, `1.`'s are used for the ordered list, which is a "best practice" (see [README.md template
]( https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or... → )

)

@jungle: That's a great idea, since many don't know it's actually valid Markdown. I just now added a line in the README.md template → about ordered lists.

@ressa, expecting your option on 🌱 [Policy] Add README.md to each submodule with optional getting translated Active , thanks!

Great idea @jungle! I added a comment in that issue, and updated the MR here, with your suggestion.

FYI, Wrapped each line in less than 80 chars, and changed reenable to re-enable

Merged, thanks!

You're welcome, it looks great.

And thank you for all your great work with the Examples module!

Automatically closed - issue fixed for 2 weeks with no activity.