search

backdrop-contrib / wpmenu

WordPress Menu for Backdrop
GNU General Public License v2.0
0 stars 0 forks source link

Clean up README.md file #1

Open jenlampton opened 8 years ago

jenlampton commented 8 years ago

The README.md file for this project is not properly formatted. Sometimes this can happen when projects are ported over from Drupal, since there wasn't a lot of direction on formatting of Drupal's README.txt files. Please refer to our contributor guidelines for an example README.md file that you can copy.

The main problem is the HTML formatting, which should be removed. Markdown files (ending in .md) have their own formatting similar to what we use here on GitHub :)

It is especially important to keep the readme files clean for Backdrop projects because that is what is used for the project page on backdropcms.org. Take a look at the page for this project to see the problem: https://backdropcms.org/project/wpmenu

matthewdorman commented 8 years ago

@jenlampton I was using two types of heading syntaxes within the README before, so I was hoping correcting that would fix the issue. I see my updates made it all the way to https://backdropcms.org/project/wpmenu, but still seeing HTML markup somehow. I don't have any markup in the source, is there something else causing this? I see some others with the same issue I have on backdropcms.org as well as many that are fine, so I'm at a bit of a loss.

jenlampton commented 8 years ago

Thanks @matthewdorman yeah, I think there is a problem with backdropcms.org, I'm looking into that now. I'm going to close this issue :)

jenlampton commented 8 years ago

Er, well, I fixed the HTML issue, but it looks like the first heading isn't being trimmed off appropriately. Attaching screenshot. screen shot 2015-09-27 at 9 32 32 pm

Is the What is wordpress menu heading necessary?