improve look and feel for lua scripting docs

This commit is contained in:
Emil Axelsson
2016-09-27 16:52:27 +02:00
parent 8fd6b66d23
commit b308890027
8 changed files with 170 additions and 17 deletions

View File

@@ -1,8 +1,4 @@
.container {
padding-top: 70px;
}
/* Documentation */
.documentation-name, .documentation-name:hover, .documentation-name:focus {
text-decoration: none;
@@ -34,7 +30,6 @@
background-color: #fff;
}
.documentation-type {
color: #888;
font-size: 0.8em;
@@ -55,7 +50,6 @@
}
/*!
* Start Bootstrap - Simple Sidebar (http://startbootstrap.com/)
* Copyright 2013-2016 Start Bootstrap

View File

@@ -0,0 +1,37 @@
<div id="wrapper">
<!-- Sidebar -->
<div id="sidebar-wrapper">
<ul class="sidebar-nav">
<li class="sidebar-brand">
<a href="#">
OpenSpace Lua Scripting
</a>
</li>
{{#each scripting}}
<li>
<a href="#openspace{{#if library}}.{{library}}{{/if}}">openspace{{#if library}}.{{library}}{{/if}}</a>
</li>
{{/each}}
</ul>
</div>
<!-- /#sidebar-wrapper -->
<div id="page-content-wrapper">
<div class="container-fluid documentation-container">
<h1>OpenSpace Lua Scripting</h1>
<p>Version: {{version.[0]}}.{{version.[1]}}.{{version.[2]}}</p>
{{#each scripting}}
<div class="row">
<div class="col-lg-12">
<h2>
<a class="documentation-name" href="#openspace{{#if library}}.{{library}}{{/if}}" name="openspace{{#if library}}.{{library}}{{/if}}">
openspace{{#if library}}.{{library}}{{/if}}
</a>
</h2>
{{> scripting}}
</div>
</div>
{{/each}}
</div>
</div>
</div>

View File

@@ -0,0 +1,28 @@
window.onload = function () {
var mainTemplateElement = document.getElementById('mainTemplate');
var mainTemplate = Handlebars.compile(mainTemplateElement.innerHTML);
var scriptingTemplateElement = document.getElementById('scriptingTemplate');
Handlebars.registerPartial('scripting', scriptingTemplateElement.innerHTML);
Handlebars.registerHelper('urlify', function(options, context) {
var data = context.data;
var identifier = options.replace(" ", "-").toLowerCase();
while (data = data._parent) {
if (data.key !== undefined) {
identifier = data.key + "-" + identifier;
}
}
return identifier;
});
var data = {
scripting: scripting,
version: version
}
var contents = mainTemplate(data);
document.body.innerHTML = contents;
}

View File

@@ -0,0 +1,17 @@
{{#each functions}}
<div class="documentation-item">
<div class="row">
<div class="col-lg-12">
<p>
<a href="#{{urlify name}}" name="{{urlify name}}">
<span class="documentation-key">{{name}}(</span>
<span class="documentation-type">{{arguments}}</span>
<span class="documentation-key">)</span>
</a>
</p>
<p class="documentation-description">{{help}}</p>
</div>
</div>
</div>
{{/each}}