Add a writer for Slate #282
Conversation
|
|
||
| | Name | Description | | ||
| |:-----------|:--------------------| | ||
| | page | Current page | |
There was a problem hiding this comment.
I know the spacing is funny, but spacing out the Markdown table would have been a lot of work for no real gain. Look at slate_example.mustache and you'll see what I mean.
|
This looks super cool. Are you able to show an example app? Super excited. |
|
@BenMorganIO There's no example to point to because I developed this for an internal tool at work. But you should be able to run this on any application, or look at the config in the Cucumber feature for more information. |
| | Name | Description | | ||
| |:-----------|:--------------------| | ||
| {{# response_fields }} | ||
| | {{#scope}}{{scope}}[{{/scope}}{{ name }}{{#scope}}]{{/scope}} | {{{ description }}} | |
There was a problem hiding this comment.
Ah, I see said the blind mouse.
|
@marnen this is amazing. Thank you! And with https://github.com/wildcardlabs/apitome_slate, we've got two tools. I think this is super going to help the community achieve awesome looking documentation, as well as give them multiple choices per their needs. I would love to see an example. Perhaps I could try out your solution with my current Solidus JSON API gem; see http://solidusapi.wildcardlabs.com. This way we have an OSS project using it and being an example to point to? |
|
@BenMorganIO I'm so glad you like it! Please do try it out on Solidus and let me know if you run into any issues. |
|
Any further thoughts on merging this? |
| #### Fields | ||
|
|
||
| | Name | Description | | ||
| |:-----------|:--------------------| |
There was a problem hiding this comment.
I could probably remove some hyphens here, but it's not a big deal.
|
What is preventing this from being merged? |
|
I haven't had time to review this yet. I should have some time later this week to get to this. |
|
Sorry for taking a while to get to this. Looks good, I'll release a new version shortly. Thanks! |
See #275. This pull request defines
SlateWriterto make it easy to generate docs that Slate can process. It writes all examples to one Slate partial (for ease of including in Slate output along with other doc files), and the output template is optimized to work well with Slate's default stylesheets.