Has anyone made a Swagger theme that generates docs similar to the layout of Tripit/Stripe's three-column API docs?
--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
You received this message because you are subscribed to a topic in the Google Groups "Swagger" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/swagger-swaggersocket/oeMyayrvKRI/unsubscribe.
To unsubscribe from this group and all its topics, send an email to swagger-swaggers...@googlegroups.com.
There is a 2.0 static codegen:
https://github.com/wordnik/swagger-codegen/tree/develop_2.0/samples/swagger-static-docs
I'd love to see the templates updated to build stipe-style docs:
https://github.com/wordnik/swagger-codegen/tree/develop_2.0/src/main/resources/swagger-static
Thank you for the great response.On Tuesday, October 21, 2014 at 10:36 PM, Max Lincoln wrote:
No... but Slate uses Markdown, and you could easily convert Swagger to Markdown.I'm not sure if there's currently a template you can use, but it should be fairly easy to create a Strip/Markdown template for any Swagger code generator. There is a swagger-to-markdown project as well, but it hasn't been updated in a few years. The "static api documentation" for swagger-codegen would probably be a good starting template, but might not have been updated to Swagger 2 yet. If you prefer Ruby and are okay w/ hacking on the tool a bit I've got the start of a generator that uses Thor generators, the same framework behind Rails and Padrino generators. It's a small, simple project (the generator is only 81 lines of code) and Thor makes it easy to write generators, but its a young project with zero documentation.
On Tue, Oct 21, 2014 at 8:33 PM, Jared Brown <jared...@gmail.com> wrote:
Has anyone made a Swagger theme that generates docs similar to the layout of Tripit/Stripe's three-column API docs?
--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsub...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
--
You received this message because you are subscribed to a topic in the Google Groups "Swagger" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/swagger-swaggersocket/oeMyayrvKRI/unsubscribe.
To unsubscribe from this group and all its topics, send an email to swagger-swaggersocket+unsub...@googlegroups.com.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsub...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
--
You received this message because you are subscribed to a topic in the Google Groups "Swagger" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/swagger-swaggersocket/oeMyayrvKRI/unsubscribe.
To unsubscribe from this group and all its topics, send an email to swagger-swaggersocket+unsub...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsub...@googlegroups.com.
--
You received this message because you are subscribed to a topic in the Google Groups "Swagger" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/swagger-swaggersocket/oeMyayrvKRI/unsubscribe.
To unsubscribe from this group and all its topics, send an email to swagger-swaggersocket+unsub...@googlegroups.com.
To unsubscribe from this group and all its topics, send an email to swagger-swaggers...@googlegroups.com.
Out of curiosity, some swagger fields are allowed to contain Markdown. This isn't really an enforced constraint (you can use any text), but projects like swagger-ui and swagger-editor assume it is markdown. If it was asciidoc instead those projects wouldn't render it properly.
Do you covert those fields from markdown to asciidoc when you're converting swagger to asciidoc, or do you assume they are either plaintext or asciidoc already?
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
Hello,
I assumed those fields are plaintext. Thanks for this hint.
Currently I use the converter to reverse engineer an Annotation-based API documentation to a Markup-based documentation like readthedocs.org (mkdocs) or JBake.
To unsubscribe from this group and all its topics, send an email to swagger-swaggers...@googlegroups.com.
Most fields are passend through as-is.
That's why, Swagger to Markdown should not be an issue.
I have to check whether AsciiDoctor supports some Markdown, otherwhise I have to convert them.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsubscri...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
--
You received this message because you are subscribed to a topic in the Google Groups "Swagger" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/swagger-swaggersocket/oeMyayrvKRI/unsubscribe.
To unsubscribe from this group and all its topics, send an email to swagger-swaggersocket+unsubscri...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsubscri...@googlegroups.com.
--
You received this message because you are subscribed to a topic in the Google Groups "Swagger" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/swagger-swaggersocket/oeMyayrvKRI/unsubscribe.
To unsubscribe from this group and all its topics, send an email to swagger-swaggersocket+unsubscri...@googlegroups.com.
--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsub...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
--
You received this message because you are subscribed to a topic in the Google Groups "Swagger" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/swagger-swaggersocket/oeMyayrvKRI/unsubscribe.
To unsubscribe from this group and all its topics, send an email to swagger-swaggersocket+unsub...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggersocket+unsub...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
--
--
You received this message because you are subscribed to a topic in the Google Groups "Swagger" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/swagger-swaggersocket/oeMyayrvKRI/unsubscribe.
To unsubscribe from this group and all its topics, send an email to swagger-swaggers...@googlegroups.com.
On Thursday, October 22, 2015 at 7:14 PM, Cory wrote:
The content of the message has not been downloaded yet.
Also, while the 3 column layout looks good at first glance, it does have some ux issues. It assumes a very wide screen since the typical user will also have one or more source files open while consulting the ref docs.
Its whitespace usage within the docs is random, dependent on the sizes of the middle and right content associated with each other. It is better to explicitly plan white space.
Its responsiveness is not so great since it collapses the two right columns into one--but the ui was planned to have the columns side by side.
Instead, I suggest checking out the rest api docs from Google. They've clearly been thinking through the problem.