Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use GitHub Flavored Markdown for parsing the markdown #84

Merged
merged 1 commit into from
Feb 4, 2014

Conversation

jeromegn
Copy link
Contributor

@jeromegn jeromegn commented Feb 4, 2014

It would really help if we could use GitHub Flavored Markdown. Especially for code snippets.

Since Kramdown uses Coderay for highlighting stuff, it's really hard to customize the highlighting colours (it adds style="color:..." to DOM nodes... not nice to override).

Using GFM really just sets the language attribute on DOM nodes. Syntax highlighting can then be more easily done with front-end libraries like Prism, Rainbow, Highlight.js...

tim-vandecasteele added a commit that referenced this pull request Feb 4, 2014
Use GitHub Flavored Markdown for parsing the markdown
@tim-vandecasteele tim-vandecasteele merged commit 80b287f into ruby-grape:master Feb 4, 2014
@tim-vandecasteele
Copy link
Contributor

100% agreed, GFM is super.

@etehtsea
Copy link

etehtsea commented Feb 4, 2014

This pr broke compatibility with JRuby because github-markdown has c-extensions.

@tim-vandecasteele
Copy link
Contributor

Merde, that was indeed why I chose kramdown to begin with.

@jeromegn as I agree with your reasoning to change to GFM, what would you think about using https://github.com/jjyr/minidown ? This should give you the code blocks you want, and minidown is pure ruby.

@jeromegn
Copy link
Contributor Author

jeromegn commented Feb 4, 2014

Kramdown can do gfm I think.

Maybe disable syntax highlighting?

Sent from Mailbox for iPhone

On Tue, Feb 4, 2014 at 7:46 AM, Tim Vandecasteele
[email protected] wrote:

Merde, that was indeed why I chose kramdown to begin with.

@jeromegn as I agree with your reasoning to change to GFM, what would you think about using https://github.com/jjyr/minidown ? This should give you the code blocks you want, and minidown is pure ruby.

Reply to this email directly or view it on GitHub:
https://github.com/tim-vandecasteele/grape-swagger/pull/84#issuecomment-34055721

tim-vandecasteele pushed a commit that referenced this pull request Feb 4, 2014
Compatibility with jruby was lost.
@tim-vandecasteele
Copy link
Contributor

Apparently they added a GFM parser in kramdown indeed.

Using this now, thanks @etehtsea for noticing, I released 0.7.1 which reverts to kramdown and uses GFM.

@etehtsea
Copy link

etehtsea commented Feb 4, 2014

@tim-vandecasteele great. Thank you!

@jeromegn jeromegn deleted the gfm branch February 4, 2014 13:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants