Wraps data from GitHub "Our World In Data" public data on vaccination rates in the US.
https://github.com/owid/covid-19-data
Hosted: https://covid-vac-watch.netcore.io/
Documentation for the service is created and hosted by GitHub pages from the local repository's docs directory.
We've utilized Instant Client Apps to help us embed working projects and multiple languages those shows how these services can be used.
Instant Client Apps is a free service hosted by ServiceStack for anyone to use to help themselves or their users get up and running with their own ServiceStack services.
Navigate to apps.servicestack.net, provide your base URL of your ServiceStack service, and explore your services until you like the code example being generated.
Once you've selected your service options, use the embed link on the right hand side to generate an iframe that you can embed in your docs.
For these docs, a simple jQuery-UI Tabs plugin was used in combination with changing each samples iframe src attribute to allow examples to be viewed in multiple lanuages.
This way we could place new examples by using key per example and choose which languages we wanted them to be shown in.
<div class="gist-cafe-tabs">
<ul>
<li><a href="query-data|csharp">C#</a></li>
<li><a href="query-data|typescript">TypeScript</a></li>
<li><a href="query-data|dart">Dart</a></li>
<li><a href="query-data|java">Java</a></li>
<li><a href="query-data|kotlin">Kotlin</a></li>
<li><a href="query-data|swift">Swift</a></li>
<li><a href="query-data|vbnet">VB.NET</a></li>
<li><a href="query-data|fsharp">F#</a></li>
</ul>
<div>
<iframe class="gist-cafe-content" src="" frameborder="0" style="height:450px;width:100%;border:1px solid #ddd"></iframe>
</div>
</div>Combined with some simple jQueryUI, this allows users of the docs to see concrete examples of how to interact with a service.
function getIFrameUrlByExampleAndLanguage(exampleId) {
var language = exampleId.split('|')[1];
var example = exampleId.split('|')[0];
return nameGistCafeMapping[example].replace('$LANG$',language);
}
$( function() {
$( ".gist-cafe-tabs" ).tabs({
beforeLoad: function( event, ui ) {
if(ui.ajaxSettings.url != null) {
var url = getIFrameUrlByExampleAndLanguage(ui.ajaxSettings.url)
$(this).find(".gist-cafe-content").attr("src",url)
}
ui.jqXHR.abort();
}
});
} );Resulting in a way to put hand crafted docs next to generated code examples.
