-
Notifications
You must be signed in to change notification settings - Fork 476
Added support for kramdown, redcarpet and custom formatters. #142
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
Conversation
I noticed redcarpet does not work with jruby because it's written in C. Maybe extract the redcarpet adapter in a separate gem? Or are there other work-arounds? |
@@ -16,6 +16,7 @@ | |||
* [#128](https://github.com/tim-vandecasteele/grape-swagger/pull/128): Combine global models and endpoint entities - [@dspaeth-faber](https://github.com/dspaeth-faber). | |||
* [#132](https://github.com/tim-vandecasteele/grape-swagger/pull/132): Addes support for enum values in entity documentation and form parameters - [@Antek-drzewiecki](https://github.com/Antek-drzewiecki). | |||
* [#135](https://github.com/tim-vandecasteele/grape-swagger/pull/135): Fixed model inclusion in models with aliased references - [@cdarne](https://github.com/cdarne). | |||
* Added support for kramdown, redcarpet and custom formatters - [@Antek-drzewiecki](https://github.com/Antek-drzewiecki). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Amend with a link to this PR.
You should be able to exclude the tests that cannot run on JRuby programmatically, start with .gemspec as explained in http://stackoverflow.com/questions/8940271/build-a-ruby-gem-and-conditionally-specify-dependencies and put conditions around specs. |
Thanks for the review, I forgot that the gemspec file is ruby too. ;) I also removed the gemfile.lock from the project since many best practices state that the lock file should not be included in ruby gems. |
This is perfect, merging. |
Added support for kramdown, redcarpet and custom formatters.
I think it would be good to add an UPGRADING document, ala Grape's and note that this is an API change. |
Good idea dblock, i'll start working on it tomorrow. |
undefined method `StandardError' for #GrapeSwagger::Markdown:0x007f40ba91e6f8 (NoMethodError) |
…anged throw of StandardError to ArgumentError.
Thank you @kai-breitbarth, spec didn't cover that very well. |
Fixed NoMethodError StandardError bug #142
Merged the fix. |
@antek-drzewiecki FYI, I added RELEASING.md, it might need a mention on the bottom about announcing a new release to read UPGRADING. |
Bump @antek-drzewiecki on UPGRADING - I was hoping to release this. |
@dblockotorg. I am currently on holyday. I found a public pc I could use to On Wed, Aug 27, 2014 at 6:48 PM, Daniel Doubrovkine (dB.) @dblockdotorg <
|
I'd take content as a comment here if that doesn't work - happy to integrate that. |
I managed to set up a pull request #147 :) I hope you find it to your liking. |
This pull requests add support for Kramdown, Redcarpet and custom markdown formatters.
To mark up your code, you need to configure grape-swagger with a markdown adapter.
Implementation relates to issue #138.
Feedback is appreciated.