CLI & static documentation generation about api-console HOT 7 CLOSED

This would be nice. So after a code push Jenkins can generate or update the API documentation.

+1

from api-console.

@oleksandr, @MMore , you don't need to use node.js at all you can deploy the dist/ directory anywhere you want, update the index.html file to point to your RAML file (which can be deployed with the console or anywhere as long as there is a public URL) and voilà.

from api-console.

@dmartinezg 👍

Could we maybe state that clearer in the readme? I was basically done setting up an external server for this - only when it occured to me after seeing your comment that the "ugly" part (lower 2/3rd) is basically only need for local testing / building / development, correct?

@oleksandr have you tried raml2html? It's basically exactly the approach you are looking for - although not as full blown as readthedocs yet, but we'll see ;)

Which brings me to my most pressing question right now: Is there any way to include / show only the "try-it" section - that is the only piece left in that puzzle, as API console is the killer app for that! :)

from api-console.

Thanks @Philzen: the raml2html thing is a good first step!

from api-console.

It's still unclear that this is possible in the documentation. We can't run the required stack on our production envrionment.

from api-console.

CLI will be provided by the new console version (see info here) and you only have to deploy the generated version on a simple HTTP server.

from api-console.

Fixed with c74eacd

from api-console.