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

Export to markdown #63

Open
macteo opened this issue Oct 17, 2012 · 2 comments
Open

Export to markdown #63

macteo opened this issue Oct 17, 2012 · 2 comments
Labels

Comments

@macteo
Copy link

macteo commented Oct 17, 2012

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
Copy link
Author

macteo commented Oct 17, 2012

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.

@macteo macteo closed this as completed Oct 17, 2012
@iNecas
Copy link
Member

iNecas commented Oct 18, 2012

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants