diff --git a/README.adoc b/README.adoc index 7597b537..ce6fd605 100644 --- a/README.adoc +++ b/README.adoc @@ -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] diff --git a/images/mkdocs_html.PNG b/images/mkdocs_html.PNG new file mode 100644 index 00000000..b1da2bf9 Binary files /dev/null and b/images/mkdocs_html.PNG differ