add GitHub Flavored Markdown to README #45

Closed
wants to merge 1 commit into
from

Projects

None yet

2 participants

@phlipper
  • This makes the example code easier to read, especially when perusing the docs on github
@phlipper phlipper add GitHub Flavored Markdown to README
* This makes the example code easier to read,
  especially when perusing the docs on github
8cd7495
@ohler55
Owner
ohler55 commented Feb 28, 2013

It makes it easier when looking at the README.md file as simple text but breaks the github home page for Ox. The original page displays correctly in github after being processed. The README.md is explicitly in markdown format and not intended to be read as simple text.

@ohler55
Owner
ohler55 commented Feb 28, 2013

If you are suggesting adding a new sample file that is easier to read I could certainly do that.

@ohler55
Owner
ohler55 commented Mar 3, 2013

Any comments?

@phlipper
phlipper commented Mar 3, 2013

@ohler55 I apologize, I didn't see your initial response. Are you referring to the homepage here? That content looks different to me. What method/library are you using to render the markdown?

I was just trying to make this look like this. Thanks.

@ohler55
Owner
ohler55 commented Mar 3, 2013

I had never seen that page. I'll have to figure out how to edit it and correct my email address. The site I was looking at is https://github.com/ohler55/ox.

Anyway, I use yardoc to generate the pages for my web site http://ohler.com/ox. The readme on github also renders the text using markdown.

Actually I like the look of your version with the colorized code samples. I would like to maintain the anchors though for external referencing. I'll try some of you changes on yardoc unless you want to see if it looks okay on your end.

-Pete

@ohler55
Owner
ohler55 commented on 8cd7495 May 3, 2013

Sorry it took so long. I could not take the changes as is. I wanted to keep the links for when the yardoc generates documentation for my web site. I did take the code reformatting changes though. Thanks for the suggestion even if it took me a long time to incorporate them.

@ohler55
Owner
ohler55 commented May 3, 2013

Sorry it took so long. I could not take the changes as is. I wanted to keep the links for when the yardoc generates documentation for my web site. I did take the code reformatting changes though. Thanks for the suggestion even if it took me a long time to incorporate them.

@ohler55 ohler55 closed this May 3, 2013
@phlipper
phlipper commented May 3, 2013

@ohler55 thanks for the feedback!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment