galaxy: reame formatting problems

Archives Ansible Project
1

Hi,

there seems to be a problem with galaxy displaying READMEs, see:

https://galaxy.ansible.com/nusenu/relayor/

vs

https://github.com/nusenu/ansible-relayor

especially the sections:
  Requirements
  Available Role Tags

2

GitHub’s markdown is a little more forgiving than Galaxy. Galaxy stores the raw README and translates to HTML on request. Galaxy also has its own CSS styles, so by definition what you see on Galaxy will be a little different.

We have been doing some work on the Galaxy styling of README files. Those changes will appear in release 2.0.1 scheduled to land on 2/26.

With the above in mind, if you indent sub-lists by 4 spaces, you should get the lists to appear the way you want. GitHub supports 2 spaces, where markdown proper requires 4. In the Requirements section, separate lists from paragraphs with a blank line. And finally, at the bottom of your README there is a numbered list, make sure each bullet has the correct number.

I forked your role, made the above minor changes and imported into our QA environment. You can see it here: https://galaxy-qa.ansible.com/chouseknecht/relayor/

–Chris

3

Chris Houseknecht:

GitHub's markdown is a little more forgiving than Galaxy. Galaxy stores the
raw README and translates to HTML on request. Galaxy also has its own CSS
styles, so by definition what you see on Galaxy will be a little different.

We have been doing some work on the Galaxy styling of README files. Those
changes will appear in release 2.0.1 scheduled to land on 2/26.

With the above in mind, if you indent sub-lists by 4 spaces, you should get
the lists to appear the way you want. GitHub supports 2 spaces, where
markdown proper requires 4. In the Requirements section, separate lists
from paragraphs with a blank line. And finally, at the bottom of your
README there is a numbered list, make sure each bullet has the correct
number.

I forked your role, made the above minor changes and imported into our QA
environment. You can see it here:
https://galaxy-qa.ansible.com/chouseknecht/relayor/

Great, thanks for fixing my README file!