search

JohnAustinDev / xulsword

Automatically exported from code.google.com/p/xulsword
17 stars 6 forks source link

Fix the MarkDown anomalies in README.md #243

Closed DavidHaslam closed 7 years ago

DavidHaslam commented 7 years ago

Some lines in the file begin with one or more #

These seem to have been intended as MarkDown format but they actually display the # signs.

Some may entail inserting a space. Others may need the line to be split as well to keep the heading short.

JohnAustinDev commented 7 years ago

The markdown used is for GitHub. Markdown isn't very standardized and can be extremely picky so you gotta pick one and go with it. So I don't plan to make changes unless GitHub requires it.

DavidHaslam commented 7 years ago

It's not as if GitHub doesn't have a preview option while you're editing, is it?

If you'd originally intended some lines as subheadings by the use of one or more # at the start, why is not a good idea to make the minor edits to ensure GitHub renders them as you'd wished?

JohnAustinDev commented 7 years ago

David, Maybe I'm missing something? The markdown looks like it should on GitHub: https://github.com/JohnAustinDev/xulsword . It is very likely that if I change it to fix your viewer (whatever that is?) then it would break the above page. I've run into this before with markdown unfortunately... -john

On 02/06/2017 01:44 PM, David Frank Haslam wrote:

It's not as if GitHub doesn't have a preview option while you're editing, is it?

If you'd originally intended some lines as subheadings by the use of one or more # at the start, why is not a good idea to make the minor edits to ensure GitHub renders them as you'd wished?

— You are receiving this because you modified the open/close state. Reply to this email directly, view it on GitHub https://github.com/JohnAustinDev/xulsword/issues/243#issuecomment-277606231, or mute the thread https://github.com/notifications/unsubscribe-auth/AK94_rdkA3dOzeRTqZ7F6Lk3xUsPCTATks5rZs9QgaJpZM4L3EoJ.

DavidHaslam commented 7 years ago

Mea culpa. It's a MarkDown redering bug in the CodeHub app for iOS.