Updated documentation

This commit is contained in:
Robert Winkler
2015-02-16 12:55:38 +01:00
parent 6ed557b4ac
commit cd4ef60cc3
2 changed files with 7 additions and 4 deletions

View File

@@ -112,19 +112,22 @@ You can generate your HTML5 and PDF documentation via https://github.com/asciido
You can also use https://github.com/tomchristie/mkdocs[MkDocs] and https://github.com/rtfd/readthedocs.org[ReadTheDocs] to publish your Markdown documentation.
See http://spring-swagger2markup-demo.readthedocs.org/[ReadTheDocs-demo]
== Example
== swagger.json
== Examples
== Swagger source file
image::images/swagger_json.PNG[swagger_json]
=== Generated AsciiDoc file
image::images/asciidoc.PNG[asciidoc]
=== Generated Markdown file
image::images/markdown.PNG[asciidoc]
image::images/markdown.PNG[markdown]
=== Generated HTML
=== Generated HTML via AsciidoctorJ
image::images/asciidoc_html.PNG[asciidoc_html]
=== Generated HTML via Mkdocs
image::images/mkdocs_html.PNG[mkdocs_html]
== Document Builder
The converter allows to build an AsciiDoc or Markdown document via the Builder pattern:
[source,java]

BIN
images/mkdocs_html.PNG Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB