Add code coloring to readme #109

Merged
merged 1 commit into from Feb 27, 2013

Conversation

Projects
None yet
4 participants
Contributor

soffes commented Feb 27, 2013

Totally understand if this kind of this isn't wanted. Personally, I think it makes reading the code in the readme much easier.

Owner

dhh commented Feb 27, 2013

I'd be happy to see this. Needs a rebase.

Owner

rafaelfranca commented Feb 27, 2013

Use the .md extension, also you need to update the Rakefile

Owner

fxn commented Feb 27, 2013

If you change this, then the rake task that generates API needs to be removed or use a different main file.

Contributor

soffes commented Feb 27, 2013

Rebased, changed to README.md, and updated Rakefile.

Owner

rafaelfranca commented Feb 27, 2013

This pull request cannot be automatically merged yet

Contributor

soffes commented Feb 27, 2013

Merged master into my branch and rebased.

Owner

fxn commented Feb 27, 2013

Were you able to generate the API and looks good?

Contributor

soffes commented Feb 27, 2013

@fxn just realized it isn't working as Markdown. Fought with it for a bit and couldn't figure it out. I generally use YARD for my projects.

If someone knows how to fix the RDoc task to generate the homepage from a Markdown file, that would be awesome. If not, I guess you can just close this. Sorry to take so much time for such a little change.

Owner

fxn commented Feb 27, 2013

If you manage to get it working with RDoc 4, which supports Markdown, that's maybe enough.

Contributor

soffes commented Feb 27, 2013

@fxn went back before my change and realized that the "home page" never worked. Fought with it for awhile and couldn't figure it out. Got the README showing up on the sidebar. It looks just fine and has coloring in the generated docs.

Merge away.

Owner

fxn commented Feb 27, 2013

Awesome, in!

@fxn fxn added a commit that referenced this pull request Feb 27, 2013

@fxn fxn Merge pull request #109 from soffes/master
Add code coloring to readme
a61c8f6

@fxn fxn merged commit a61c8f6 into rails:master Feb 27, 2013

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