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

Offline docs / distributable docs? #80

Closed
jameselsey opened this Issue Jan 22, 2015 · 2 comments

Comments

Projects
None yet
2 participants
@jameselsey

jameselsey commented Jan 22, 2015

More of a question than an issue...

Are there any features/workarounds to have offline documentation? For example if developers don't have access to your hosted API docs, is there an easy way to save these, or generate something to distribute?

@fabiomaffioletti

This comment has been minimized.

Show comment
Hide comment
@fabiomaffioletti

fabiomaffioletti Jan 22, 2015

Owner

Currently there are two ways of doing that:

  1. use the jsondoc-maven-plugin (how to on the website). But the plugin uses the DefaultJSONDocScanner, so if you are in a Spring project it will probably don't produce the doc you expect (maybe in the future it would be good to let the plugin user specify which scanner implementation to use in the plugin)
  2. save the output of the jsondoc endpoint to a file and distribute that file, that is actually a json file containing the documentation. To view that, you can customize the jsondoc-ui to take a json file as input instead of fetching it from a url
Owner

fabiomaffioletti commented Jan 22, 2015

Currently there are two ways of doing that:

  1. use the jsondoc-maven-plugin (how to on the website). But the plugin uses the DefaultJSONDocScanner, so if you are in a Spring project it will probably don't produce the doc you expect (maybe in the future it would be good to let the plugin user specify which scanner implementation to use in the plugin)
  2. save the output of the jsondoc endpoint to a file and distribute that file, that is actually a json file containing the documentation. To view that, you can customize the jsondoc-ui to take a json file as input instead of fetching it from a url

@fabiomaffioletti fabiomaffioletti added this to the 1.1.4 milestone Jan 23, 2015

@fabiomaffioletti fabiomaffioletti self-assigned this Jan 23, 2015

@fabiomaffioletti fabiomaffioletti modified the milestone: 1.1.4 Jan 23, 2015

@fabiomaffioletti

This comment has been minimized.

Show comment
Hide comment
@fabiomaffioletti

fabiomaffioletti Jan 23, 2015

Owner

Docs available here: http://jsondoc.org/how-to-maven-plugin.html
Reopen if needed.

Owner

fabiomaffioletti commented Jan 23, 2015

Docs available here: http://jsondoc.org/how-to-maven-plugin.html
Reopen if needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment