diff options
Diffstat (limited to 'platform/darwin/docs/theme/templates')
7 files changed, 216 insertions, 0 deletions
diff --git a/platform/darwin/docs/theme/templates/doc.mustache b/platform/darwin/docs/theme/templates/doc.mustache new file mode 100644 index 0000000000..b16521a431 --- /dev/null +++ b/platform/darwin/docs/theme/templates/doc.mustache @@ -0,0 +1,53 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <title>{{name}} {{kind}} Reference</title> + <link rel="stylesheet" type="text/css" href="{{path_to_root}}css/jazzy.css" /> + <link rel="stylesheet" type="text/css" href="{{path_to_root}}css/highlight.css" /> + <meta charset="utf-8"> + <script src="{{path_to_root}}js/jquery.min.js" defer></script> + <script src="{{path_to_root}}js/jazzy.js" defer></script> + {{{custom_head}}} + </head> + <body> + + {{#dash_type}} + <a name="//apple_ref/{{language_stub}}/{{dash_type}}/{{name}}" class="dashAnchor"></a> + {{/dash_type}} + + <a title="{{name}} {{kind}} Reference"></a> + + {{> header}} + + <p class="breadcrumbs"> + <a class="breadcrumb" href="{{path_to_root}}index.html">{{module_name}} Reference</a> + <img class="carat" src="{{path_to_root}}img/carat.png" /> + {{name}} {{kind}} Reference + </p> + + <div class="content-wrapper"> + {{> nav}} + <article class="main-content"> + + <section class="section"> + <div class="section-content"> + {{^hide_name}}<h1>{{name}}</h1>{{/hide_name}} + {{#declaration}} + <div class="declaration"> + <div class="language"> + {{{declaration}}} + </div> + </div> + {{/declaration}} + {{{overview}}} + </div> + </section> + + {{> tasks}} + + </article> + </div> + {{> footer}} + </body> +</div> +</html> diff --git a/platform/darwin/docs/theme/templates/footer.mustache b/platform/darwin/docs/theme/templates/footer.mustache new file mode 100644 index 0000000000..e72ede6126 --- /dev/null +++ b/platform/darwin/docs/theme/templates/footer.mustache @@ -0,0 +1,3 @@ +<section class="footer"> + {{{copyright}}} Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v{{jazzy_version}}</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project. +</section> diff --git a/platform/darwin/docs/theme/templates/header.mustache b/platform/darwin/docs/theme/templates/header.mustache new file mode 100644 index 0000000000..15e35b9a81 --- /dev/null +++ b/platform/darwin/docs/theme/templates/header.mustache @@ -0,0 +1,28 @@ +<header class="header"> + <p class="header-col header-col--primary"> + <a class="header-link" href="{{path_to_root}}index.html"> + <img class="header-icon" src="{{path_to_root}}img/mapbox.svg" alt="{{module_name}} Docs"/> + </a> + {{#doc_coverage}} ({{doc_coverage}}% documented){{/doc_coverage}} + </p> + + {{#github_url}} + <p class="header-col header-col--secondary"> + <a class="header-link" href="{{github_url}}"> + <svg class="header-icon" viewBox="0 0 33 33" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"> + <path stroke="none" stroke-width="1" fill="white" fill-rule="evenodd" d="M16.6,0.4 C7.6,0.4 0.3,7.7 0.3,16.7 C0.3,23.9 5,30 11.4,32.2 C12.2,32.3 12.5,31.8 12.5,31.4 L12.5,28.6 C8,29.6 7,26.4 7,26.4 C6.3,24.5 5.2,24 5.2,24 C3.7,23 5.3,23 5.3,23 C6.9,23.1 7.8,24.7 7.8,24.7 C9.3,27.2 11.6,26.5 12.5,26.1 C12.6,25 13.1,24.3 13.5,23.9 C9.9,23.5 6.1,22.1 6.1,15.8 C6.1,14 6.7,12.6 7.8,11.4 C7.6,11 7.1,9.3 8,7.1 C8,7.1 9.4,6.7 12.5,8.8 C13.8,8.4 15.2,8.3 16.6,8.3 C18,8.3 19.4,8.5 20.7,8.8 C23.8,6.7 25.2,7.1 25.2,7.1 C26.1,9.3 25.5,11 25.4,11.4 C26.4,12.5 27.1,14 27.1,15.8 C27.1,22.1 23.3,23.4 19.7,23.8 C20.3,24.3 20.8,25.3 20.8,26.8 L20.8,31.3 C20.8,31.7 21.1,32.2 21.9,32.1 C28.4,29.9 33,23.8 33,16.6 C32.9,7.7 25.6,0.4 16.6,0.4 L16.6,0.4 Z"></path> + </svg> + View on GitHub + </a> + </p> + {{/github_url}} + + {{#dash_url}} + <p class="header-col header-col--secondary"> + <a class="header-link" href="{{dash_url}}"> + <img class="header-icon" src="{{path_to_root}}img/dash.png"/> + Install in Dash + </a> + </p> + {{/dash_url}} +</header> diff --git a/platform/darwin/docs/theme/templates/nav.mustache b/platform/darwin/docs/theme/templates/nav.mustache new file mode 100644 index 0000000000..f7de866712 --- /dev/null +++ b/platform/darwin/docs/theme/templates/nav.mustache @@ -0,0 +1,16 @@ +<nav class="navigation"> + <ul class="nav-groups"> + {{#structure}} + <li class="nav-group-name"> + <a class="nav-group-name-link" href="{{path_to_root}}{{section}}.html">{{section}}</a> + <ul class="nav-group-tasks"> + {{#children}} + <li class="nav-group-task"> + <a class="nav-group-task-link" href="{{path_to_root}}{{url}}">{{name}}</a> + </li> + {{/children}} + </ul> + </li> + {{/structure}} + </ul> +</nav> diff --git a/platform/darwin/docs/theme/templates/parameter.mustache b/platform/darwin/docs/theme/templates/parameter.mustache new file mode 100644 index 0000000000..6fa329d72e --- /dev/null +++ b/platform/darwin/docs/theme/templates/parameter.mustache @@ -0,0 +1,12 @@ +<tr> + <td> + <code> + <em>{{name}}</em> + </code> + </td> + <td> + <div> + {{{discussion}}} + </div> + </td> +</tr> diff --git a/platform/darwin/docs/theme/templates/task.mustache b/platform/darwin/docs/theme/templates/task.mustache new file mode 100644 index 0000000000..dd30c670eb --- /dev/null +++ b/platform/darwin/docs/theme/templates/task.mustache @@ -0,0 +1,95 @@ +<div class="task-group"> + {{#name}} + <div class="task-name-container"> + <a name="/{{uid}}"></a> + <a name="//apple_ref/{{language_stub}}/Section/{{name}}" class="dashAnchor"></a> + <a href="#/{{uid}}"> + <h3 class="section-name">{{name}}</h3> + </a> + </div> + {{/name}} + <ul class="item-container"> + {{#items}} + <li class="item"> + <div> + <code> + <a name="/{{usr}}"></a> + <a name="//apple_ref/{{language_stub}}/{{dash_type}}/{{name}}" class="dashAnchor"></a> + <a class="token" href="#/{{usr}}">{{name}}</a> + </code> + {{#default_impl_abstract}} + <span class="declaration-note"> + Default implementation + </span> + {{/default_impl_abstract}} + {{#from_protocol_extension}} + <span class="declaration-note"> + Extension method + </span> + {{/from_protocol_extension}} + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + {{#abstract}} + <div class="abstract"> + {{{abstract}}} + {{#url}} + <a href="{{{path_to_root}}}{{{url}}}" class="slightly-smaller">See more</a> + {{/url}} + </div> + {{/abstract}} + {{#default_impl_abstract}} + <h4>Default Implementation</h4> + <div class="default_impl abstract"> + {{{default_impl_abstract}}} + </div> + {{/default_impl_abstract}} + {{#declaration}} + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">{{language}}</p> + {{{declaration}}} + </div> + {{#other_language_declaration}} + <div class="language"> + <p class="aside-title">Swift</p> + {{{other_language_declaration}}} + </div> + {{/other_language_declaration}} + </div> + {{/declaration}} + {{#parameters.count}} + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + {{#parameters}} + {{> parameter}} + {{/parameters}} + </tbody> + </table> + </div> + {{/parameters.count}} + {{#return}} + <div> + <h4>Return Value</h4> + {{{return}}} + </div> + {{/return}} + {{#github_token_url}} + <div class="slightly-smaller show-on-github"> + <a href="{{{github_token_url}}}"> + show on github + <img class="show-on-github-icon" src="{{{path_to_root}}}img/github.svg"/> + </a> + </div> + {{/github_token_url}} + </section> + </div> + </li> + {{/items}} + </ul> +</div> diff --git a/platform/darwin/docs/theme/templates/tasks.mustache b/platform/darwin/docs/theme/templates/tasks.mustache new file mode 100644 index 0000000000..16f65e096b --- /dev/null +++ b/platform/darwin/docs/theme/templates/tasks.mustache @@ -0,0 +1,9 @@ +{{#tasks.count}} +<section class="section"> + <div class="section-content"> + {{#tasks}} + {{> task}} + {{/tasks}} + </div> +</section> +{{/tasks.count}} |