Using syntax highlighting, clarifying source. #22

Merged
merged 1 commit into from Nov 7, 2011

4 participants

@krainboltgreene

No description provided.

@solnic
Owner

Thanks man, I actually did that once but noticed that when YARD generates docs it doesn't digest those fancy ``` markers so I removed them from README.

Do you know a way of making it parse properly this syntax?

@krainboltgreene

Ooh, no. I didn't know YARD didn't like it. Hmm, damn that's a hard one.

@RipTheJacker

I believe you have to tell YARD to use markdown syntax via command line tool.

@krainboltgreene
@solnic
Owner

@RipTheJacker I'm pretty sure I was running it with markdown parameter. I need to double check that though

@krainboltgreene Yes I think that was the case

@dkubb
Collaborator

I would love to find a solution to this problem too.

In my own projects I've chosen to side with making the code look nice on github, and not so much YARD since more people are going to view the github page than generate their own YARD docs.

Even still, I would much prefer an approach that provides nice syntax highlighting for my README on github and will generate something readable using YARD. I'd love to see syntax highlighting in YARD too, but I'd settle with something that was readable.

@solnic
Owner

@dkubb I think it would require some simple YARD extension

@dkubb
Collaborator

@solnic yeah, although my concern would be for RubyDoc.info to have nicely generated docs as well as on people's machines. I can control how docs are generated when people download the gem, by specifying development dependencies, but I can't really control how RubyDoc.info displays things without using standard YARD syntax or working with them to support Github Flavored Markdown too.

@solnic solnic merged commit af6a7cd into solnic:master Nov 7, 2011
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment