search

Apipie / apipie-rails

Ruby on Rails API documentation tool
Apache License 2.0
2.47k stars 463 forks source link

Export to markdown #63

Open macteo opened 12 years ago

macteo commented 12 years ago

I'm facing the needs of exporting the documentation created with Apipie to be used on pdf documents and other sites and I found that there isn't an export feature.

I used the rake apipie:static to get the html and found that I cannot convert it to markdown with Pandoc.

It would be very useful if you add an export method to create static markdown pages.

A possible template could be this one.

macteo commented 12 years ago

I needed that feature so I've created the exporter as rake task rake apipie:markdown. It isn't polished nor tested and includes some dependancies and layout changes related to my project but you can find it if you need it on this repo.

Side note: I've also added a success section for each method (copy of the errors) to represent successful (200) request and the json returned. The examples are (for me at least) more useful to post curl o ajax functions.

iNecas commented 12 years ago

Thanks for heads up, let's keep this issue open so that we don't forget about that.