kiss-lang/lime
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc improvements

Browse Source
This commit is contained in:
Joshua Granick
2018-07-05 17:38:34 -07:00
parent cda51acedc
commit 6876a0a9c3
6 changed files with 346 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
assets/docs-theme/config.json Normal file
View File

@@ -0,0 +1,5 @@
{
"name": "Lime Theme",
"author": "Lime",
"parentTheme": "default"
}

BIN
assets/docs-theme/resources/images/logo.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 17 KiB

253
assets/docs-theme/resources/index.js Normal file
View File

@@ -0,0 +1,253 @@
function createCookie(name, value, days) {
localStorage.setItem(name, value);
}
function readCookie(name) {
return localStorage.getItem(name);
}
function toggleInherited(el) {
var toggle = $(el).closest(".toggle");
toggle.toggleClass("toggle-on");
if (toggle.hasClass("toggle-on")) {
$("i", toggle).removeClass("fa-arrow-circle-right").addClass("fa-arrow-circle-down");
} else {
$("i", toggle).addClass("fa-arrow-circle-right").removeClass("fa-arrow-circle-down");
}
return false;
}
function toggleCollapsed(el) {
var toggle = $(el).closest(".expando");
toggle.toggleClass("expanded");
if (toggle.hasClass("expanded")) {
$(toggle).find("i").first().removeClass("fa-arrow-circle-right").addClass("fa-arrow-circle-down");
} else {
$(toggle).find("i").first().addClass("fa-arrow-circle-right").removeClass("fa-arrow-circle-down");
}
updateTreeState();
return false;
}
function updateTreeState(){
var states = [];
$("#nav .expando").each(function(i, e){
states.push($(e).hasClass("expanded") ? 1 : 0);
});
var treeState = JSON.stringify(states);
createCookie("treeState", treeState);
}
var filters = {};
function selectVersion(e) {
setVersion($(e.target).parent().attr("data"));
}
function setPlatform(platform) {
createCookie("platform", platform);
$("#select-platform").val(platform);
var styles = ".platform { display:inherit } ";
var platforms = dox.platforms;
styles += ".package-sys { display:" + ((platform == "Flash" || platform == "HTML5") ? "none" : "inherit") + " } ";
styles += ".package-cpp { display:" + ((platform == "Flash" || platform == "HTML5" || platform == "Neko") ? "none" : "inherit") + " } ";
styles += ".package-neko { display:" + ((platform == "Neko" || platform == "all") ? "inherit" : "none") + " } ";
styles += ".package-js { display:" + ((platform == "HTML5" || platform == "all") ? "inherit" : "none") + " } ";
for (var i = 0; i < platforms.length; i++) {
var p = platforms[i];
if (platform == "all" || p == platform) {
styles += ".platform-" + p + " { display:inherit } ";
} else {
styles += ".platform-" + p + " { display:none } ";
}
}
$("#dynamicStylesheet").text(styles);
}
/*
function setVersion(version) {
createCookie("version", version);
}
*/
$(document).ready(function(){
$("#nav").html(navContent);
var treeState = readCookie("treeState");
$("#nav .expando").each(function(i, e){
$("i", e).first().addClass("fa-arrow-circle-right").removeClass("fa-arrow-circle-down");
});
$(".treeLink").each(function() {
this.href = this.href.replace("::rootPath::", dox.rootPath);
});
if (treeState != null)
{
var states = JSON.parse(treeState);
$("#nav .expando").each(function(i, e){
if (states[i]) {
$(e).addClass("expanded");
$("i", e).first().removeClass("fa-arrow-circle-right").addClass("fa-arrow-circle-down");
}
});
}
$("head").append("<style id='dynamicStylesheet'></style>");
setPlatform(readCookie("platform") == null ? "all" : readCookie("platform"));
//setVersion(readCookie("version") == null ? "3_0" : readCookie("version"));
var searchBox = $("#search");
searchBox.on("input", function(e){
searchQuery(e.target.value);
});
$(window).keydown(function(e){
if (searchBox.is(":focus")) {
return true;
} else if (e.key === "/" || e.keyCode == 191 /* slash */) {
searchBox.focus();
return false;
} else if (!e.ctrlKey && !e.metaKey && (
// e.key is only available in newer browsers. On older
// browsers, we use an ugly blacklist of well-known
// non-printable keyCodes, and assume everything else is
// printable.
(typeof e.key == "string" && e.key.length == 1 && e.key != " ") ||
(typeof e.key == "undefined" && [8, 9, 13, 16, 17, 32, 33, 34, 35, 36, 37, 38, 39, 40, 45, 46, 91, 92, 93, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 144, 145].indexOf(e.keyCode) >= 0))) {
searchBox.focus();
return true;
} else {
return true;
}
});
searchBox.keydown(function(e){
if (e.keyCode == 27 /* Esc */) {
this.blur();
return false;
}
return true;
});
$("#select-platform").selectpicker().on("change", function(e){
var value = $(":selected", this).val();
setPlatform(value);
});
$("#nav a").each(function () {
if (this.href == location.href) {
$(this.parentElement).addClass("active");
}
});
$("a.expand-button").click(function (e) {
var container = $(this).parent().next();
container.toggle();
$("i", this).removeClass("fa-arrow-circle-down")
.removeClass("fa-arrow-circle-right")
.addClass(container.is(":visible") ? "fa-arrow-circle-down" : "fa-arrow-circle-right");
return false;
});
// Because there is no CSS parent selector
$("code.prettyprint").parents("pre").addClass("example");
});
function searchQuery(query) {
$("#searchForm").removeAttr("action");
query = query.replace(/[&<>"']/g, "");
if (!query || query.length<2) {
$("#nav").removeClass("searching");
$("#nav li").each(function(index, element){
var e = $(element);
e.css("display", "");
});
$("#nav ul:first-child").css("display", "block");
$("#search-results-list").css("display", "none");
return;
}
var queryParts = query.toLowerCase().split(" ");
var listItems = [];
var bestMatch = 200;
$("#nav").addClass("searching");
$("#nav ul:first-child").css("display","none");
$("#nav li").each(function(index, element) {
var e = $(element);
if (!e.hasClass("expando")) {
var content = e.attr("data_path");
var score = searchMatch(content, queryParts);
if (score >= 0) {
if (score < bestMatch) {
var url = dox.rootPath + e.attr("data_path").split(".").join("/") + ".html";
$("#searchForm").attr("action", url);
// best match will be form action
bestMatch = score;
}
var elLink = $("a", element);
// highlight matched parts
var elLinkContent = elLink.text().replace(new RegExp("(" + queryParts.join("|").split(".").join("|") + ")", "ig"), "<strong>$1</strong>");
var liStyle = (score == 0) ? ("font-weight:bold") : "";
listItems.push({score: score, item: "<li style='" + liStyle + "'><a href='"+elLink.attr("href")+"'>" + elLinkContent + "</a></li>"});
}
}
});
if ($("#search-results-list").length == 0) {
// append to nav
$("#nav").parent().append("<ul id='search-results-list' class='nav nav-list'></ul>");
}
listItems.sort(function(x, y) { return x.score - y.score; }); // put in order
$("#search-results-list").css("display","block").html(listItems.map(function(x) { return x.item; }).join(""));
}
function match(textParts, query) {
var queryParts = query.split(".");
if (queryParts.length == 1) {
var queryPart = queryParts[0];
for (var i = 0; i < textParts.length; ++i) {
var textPart = textParts[i];
if (textPart.indexOf(queryPart) > -1) {
// We don't want to match the same part twice, so let's remove it
textParts[i] = textParts[i].split(queryPart).join("");
return textPart.length - queryPart.length;
}
}
} else {
var offset = -1;
outer:
while (true) {
++offset;
if (queryParts.length + offset > textParts.length) {
return -1;
}
var scoreSum = 0;
for (var i = 0; i < queryParts.length; ++i) {
var queryPart = queryParts[i];
var textPart = textParts[i + offset];
var index = textPart.indexOf(queryPart);
if (index != 0) {
continue outer;
}
scoreSum += textPart.length - queryPart.length;
}
return scoreSum;
}
}
}
function searchMatch(text, queryParts) {
text = text.toLowerCase();
var textParts = text.split(".");
var scoreSum = 0;
for (var i = 0; i < queryParts.length; ++i) {
var score = match(textParts, queryParts[i]);
if (score == -1) {
return -1;
}
scoreSum += score + text.length;
}
return scoreSum;
}

36
assets/docs-theme/templates/package_description.mtt Normal file
View File

@@ -0,0 +1,36 @@
<h1>::api.currentPageName:: <small ::cond api.isDefined("version") && full == ""::>version ::api.getValue('version')::</small></h1>
<p ::cond api.isDefined("description")::>::api.getValue("description")::</p>
<!--
::if full == ""::
<h1>Haxe API documentation <small ::cond api.isDefined("version")::>version ::api.getValue('version')::</small></h1>
<p>Haxe is an open source toolkit based on a modern, high level, strictly typed programming language, a cross-compiler, a complete cross-platform standard library and ways to access each platform's native capabilities.</p>
<h3>Getting Started With Haxe</h3>
<ul>
<li>Take a look at our <a href="http://haxe.org/documentation/introduction/">introduction</a></li>
<li>Read through the <a href="http://haxe.org/manual/">Haxe Manual</a></li>
<li>Look at these <a href="http://haxe.org/use-cases/">use cases for Haxe</a></li>
<li>Find and install <a href="http://lib.haxe.org/t/all/">popular Haxe libraries</a></li>
<li>Learn by example with the <a href="http://code.haxe.org">Haxe Code Cookbook</a></li>
</ul>
<hr/>
<h3>Top Level</h3>
::elseif full.split(".").length==1::
<h1>Haxe/::full:: API documentation</h1>
<p>To get started with the Haxe ::full:: target:</p>
<ul>
<li>Read through the <a href="http://haxe.org/manual/">Haxe Manual</a></li>
<li ::cond full=="js"::>Read the <a href="http://haxe.org/manual/target-javascript.html">Haxe/JavaScript target details</a></li>
<li ::cond full=="flash"::>Read the <a href="http://haxe.org/manual/target-flash.html">Haxe/Flash target details</a></li>
<li ::cond full=="php"::>Read the <a href="http://haxe.org/manual/target-php.html">Haxe/PHP target details</a></li>
<li ::cond full=="cpp"::>Read the <a href="http://haxe.org/manual/target-cpp.html">Haxe/C++ target details</a></li>
<li ::cond full=="neko"::>Read the <a href="http://nekovm.org/doc">Neko documentation</a></li>
<li>Find and install <a href="http://lib.haxe.org/t/::full::/">popular Haxe/::full:: libraries</a></li>
<li>Learn by example with the <a href="http://code.haxe.org">Haxe Code Cookbook</a></li>
</ul>
<hr/>
<h1><small class="directive">package</small> ::full::</h1>
::else::
<h1><small class="directive">package</small> ::full::</h1>
::end::
-->

51
assets/docs-theme/templates/topbar.mtt Normal file
View File

@@ -0,0 +1,51 @@
<style>
::raw "
a, code .type {
color: #6fac17;
}
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
.navbar .brand img {
max-width: 75px;
}
.nav-list>.active>a.treeLink, .nav-list>.active>a.treeLink:hover, .nav-list>.active>a.treeLink:focus {
background: #6fac17;
color: #ffffff;
text-shadow: 0 0 0 transparent;
}
.navbar .container {
width: 940px ;
}
@media (max-width: 767px) {
.navbar .container {
width: auto;
}
}
@media (max-width: 979px) and (min-width: 768px) {
.navbar .container {
width: 724px;
}
}
@media (min-width: 1200px) {
.navbar .container {
width: 1170px;
}
}
.navbar .container img {
margin: 5px 0 0 4px;
}
"::
</style>
<nav class="nav">
<div class="navbar">
<div class="navbar-inner" style="background:$$getHexValue(::themeColor::); border-bottom:1px solid rgba(0,0,0,.09)">
<div class="container">
<a ::cond api.isDefined("logo"):: ::attr href if(api.isDefined("website")) api.getValue("website") else api.config.rootPath:: class="brand"><img alt="" ::attr src api.getValue("logo"):: /></a>
<a ::attr href api.config.rootPath:: class="brand" style="color:$$getHexValue(::textColor::)">::if api.config.pageTitle!=null::::api.config.pageTitle::::else::Lime API Documentation::end::</a>
</div>
</div>
</div>
</nav>

2
docs/api/build.hxml
View File

@@ -134,4 +134,4 @@ ImportAll
--next
-cmd haxelib run dox -i xml -in lime --title "Lime API Reference" -D website "http://www.openfl.org/lime" -D textColor 0x777777
-cmd haxelib run dox -i xml -in lime --title "Lime API Reference" -D website "http://lime.software" -D logo "/images/logo.png" -D textColor 0x777777 -theme ../../assets/docs-theme --toplevel-package lime