summaryrefslogtreecommitdiff
path: root/theme/templates
diff options
context:
space:
mode:
authorJoel Fischer <joeljfischer@gmail.com>2016-06-02 13:40:32 -0400
committerJoel Fischer <joeljfischer@gmail.com>2016-06-02 13:40:32 -0400
commitdcebff15a8c743a8ee652c1e5c91d2c59a6129cf (patch)
treed0e9b549e9f4ee09de78901213200353d28b7034 /theme/templates
parent3099a23fceb1bf717cd683893e0f6a759e02d5cb (diff)
downloadsdl_ios-dcebff15a8c743a8ee652c1e5c91d2c59a6129cf.tar.gz
Add Jazzy theme, scripts, initial documentation, and an updated gitignore
Diffstat (limited to 'theme/templates')
-rwxr-xr-xtheme/templates/doc.mustache16
-rwxr-xr-xtheme/templates/nav.mustache8
-rwxr-xr-xtheme/templates/parameter.mustache2
-rwxr-xr-xtheme/templates/task.mustache50
-rw-r--r--theme/templates/task_link.mustache3
-rw-r--r--theme/templates/task_links.mustache7
-rwxr-xr-xtheme/templates/tasks.mustache7
7 files changed, 93 insertions, 0 deletions
diff --git a/theme/templates/doc.mustache b/theme/templates/doc.mustache
new file mode 100755
index 000000000..6317beb02
--- /dev/null
+++ b/theme/templates/doc.mustache
@@ -0,0 +1,16 @@
+{{#hide_name}}
+{{> nav}}
+{{/hide_name}}
+{{^hide_name}}
+<h1>{{name}} {{kind}} Reference</h1>
+
+<h3>Section Contents</h3>
+
+{{> task_links}}
+
+<h3>Overview</h3>
+
+{{{overview}}}
+
+{{> tasks}}
+{{/hide_name}}
diff --git a/theme/templates/nav.mustache b/theme/templates/nav.mustache
new file mode 100755
index 000000000..fe7d8cdf2
--- /dev/null
+++ b/theme/templates/nav.mustache
@@ -0,0 +1,8 @@
+{{#structure}}
+- name: {{section}}
+ sub_nav:
+{{#children}}
+ - name: {{name}}
+ url: {{path_to_root}}{{url}}
+{{/children}}
+{{/structure}}
diff --git a/theme/templates/parameter.mustache b/theme/templates/parameter.mustache
new file mode 100755
index 000000000..aca965950
--- /dev/null
+++ b/theme/templates/parameter.mustache
@@ -0,0 +1,2 @@
+<dt>{{name}}</dt>
+<dd>{{{discussion}}}</dd>
diff --git a/theme/templates/task.mustache b/theme/templates/task.mustache
new file mode 100755
index 000000000..815a9e22a
--- /dev/null
+++ b/theme/templates/task.mustache
@@ -0,0 +1,50 @@
+{{#items}}
+<h3>
+ {{name}}
+ {{#default_impl_abstract}}
+ Default implementation
+ {{/default_impl_abstract}}
+ {{#from_protocol_extension}}
+ Extension method
+ {{/from_protocol_extension}}
+</h3>
+
+{{#abstract}}
+{{{abstract}}}
+{{#url}}
+<a href="{{{path_to_root}}}{{{url}}}" class="slightly-smaller">See more</a>
+{{/url}}
+{{/abstract}}
+
+{{#default_impl_abstract}}
+<h4>Default Implementation</h4>
+{{{default_impl_abstract}}}
+{{/default_impl_abstract}}
+
+{{#declaration}}
+<h4>{{language}}</h4>
+{{{declaration}}}
+
+{{#other_language_declaration}}
+<h4>Swift</h4>
+{{{other_language_declaration}}}
+{{/other_language_declaration}}
+{{/declaration}}
+
+
+{{#parameters.count}}
+<h4>Parameters</h4>
+<dl>
+ {{#parameters}}
+ {{> parameter}}
+ {{/parameters}}
+</dl>
+{{/parameters.count}}
+{{#return}}
+<div>
+ <h4>Return Value</h4>
+ {{{return}}}
+</div>
+{{/return}}
+
+{{/items}}
diff --git a/theme/templates/task_link.mustache b/theme/templates/task_link.mustache
new file mode 100644
index 000000000..2d91f145d
--- /dev/null
+++ b/theme/templates/task_link.mustache
@@ -0,0 +1,3 @@
+{{#items}}
+<li><a href="#section-{{name}}">{{name}}</a></li>
+{{/items}}
diff --git a/theme/templates/task_links.mustache b/theme/templates/task_links.mustache
new file mode 100644
index 000000000..1ae88f4db
--- /dev/null
+++ b/theme/templates/task_links.mustache
@@ -0,0 +1,7 @@
+{{#tasks.count}}
+<ul>
+ {{#tasks}}
+ {{> task_link}}
+ {{/tasks}}
+</ul>
+{{/tasks.count}}
diff --git a/theme/templates/tasks.mustache b/theme/templates/tasks.mustache
new file mode 100755
index 000000000..f97bb437f
--- /dev/null
+++ b/theme/templates/tasks.mustache
@@ -0,0 +1,7 @@
+{{#tasks.count}}
+<section class="section task-group-section">
+ {{#tasks}}
+ {{> task}}
+ {{/tasks}}
+</section>
+{{/tasks.count}}