aboutsummaryrefslogtreecommitdiffstats
path: root/site/_includes
diff options
context:
space:
mode:
authorStephane Desneux <stephane.desneux@iot.bzh>2016-11-08 12:39:57 +0100
committerStephane Desneux <stephane.desneux@iot.bzh>2016-11-10 14:53:01 +0100
commitc530e84843444a40804e0c2b038c2ec53fe411b2 (patch)
tree1a9eebf49fd85027ba472bad8c178d686bad8d56 /site/_includes
webdocs-agl: added developer website template
Change-Id: I4a45ee0ad5dd0c29a6d6876a0e02cd5550c010e9 Signed-off-by: Stephane Desneux <stephane.desneux@iot.bzh>
Diffstat (limited to 'site/_includes')
-rw-r--r--site/_includes/algolia.html20
-rw-r--r--site/_includes/analytics.html8
-rw-r--r--site/_includes/comment_count.html9
-rw-r--r--site/_includes/disqus.html10
-rw-r--r--site/_includes/footer_contents.html63
-rw-r--r--site/_includes/footer_docs.html6
-rw-r--r--site/_includes/footer_site.html6
-rw-r--r--site/_includes/generated_index.html39
-rw-r--r--site/_includes/head.html63
-rw-r--r--site/_includes/header.html57
-rw-r--r--site/_includes/sitemap_entry.html5
-rw-r--r--site/_includes/toc_recursive_dropdown.html13
-rw-r--r--site/_includes/toc_recursive_main.html28
-rw-r--r--site/_includes/tools_and_showcase.html66
-rw-r--r--site/_includes/twitterFeed.html20
15 files changed, 413 insertions, 0 deletions
diff --git a/site/_includes/algolia.html b/site/_includes/algolia.html
new file mode 100644
index 0000000..3008a1c
--- /dev/null
+++ b/site/_includes/algolia.html
@@ -0,0 +1,20 @@
+{% if page.version %}
+ {% assign version = page.version %}
+{% else %}
+ {% assign version = site.latest_docs_version %}
+{% endif %}
+
+{% if page.language %}
+ {% assign language = page.language %}
+{% else %}
+ {% assign language = site.language %}
+{% endif %}
+
+<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
+<script type="text/javascript">
+ docsearch({
+ apiKey: '{{ site.algolia.apikey }}',
+ indexName: '{{ site.algolia.index }}',
+ inputSelector: '#header-search-field',
+ });
+</script>
diff --git a/site/_includes/analytics.html b/site/_includes/analytics.html
new file mode 100644
index 0000000..b409f2d
--- /dev/null
+++ b/site/_includes/analytics.html
@@ -0,0 +1,8 @@
+<script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+ ga('create', '{{ page.analytics_id }}', 'auto');
+ ga('send', 'pageview');
+</script>
diff --git a/site/_includes/comment_count.html b/site/_includes/comment_count.html
new file mode 100644
index 0000000..d7d8e37
--- /dev/null
+++ b/site/_includes/comment_count.html
@@ -0,0 +1,9 @@
+<script type="text/javascript">
+ /* * * DON'T EDIT BELOW THIS LINE * * */
+ (function () {
+ var s = document.createElement('script'); s.async = true;
+ s.type = 'text/javascript';
+ s.src = '//{{ site.disqus.name }}.disqus.com/count.js';
+ (document.getElementsByTagName('HEAD')[0] || document.getElementsByTagName('BODY')[0]).appendChild(s);
+ }());
+</script>
diff --git a/site/_includes/disqus.html b/site/_includes/disqus.html
new file mode 100644
index 0000000..2aeaaf3
--- /dev/null
+++ b/site/_includes/disqus.html
@@ -0,0 +1,10 @@
+<div id="disqus_thread"></div>
+<script type="text/javascript">
+ /* * * DON'T EDIT BELOW THIS LINE * * */
+ (function() {
+ var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
+ dsq.src = '//{{ site.disqus.name }}.disqus.com/embed.js';
+ (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
+ })();
+</script>
+<noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript" rel="nofollow">comments powered by Disqus.</a></noscript>
diff --git a/site/_includes/footer_contents.html b/site/_includes/footer_contents.html
new file mode 100644
index 0000000..6b913e6
--- /dev/null
+++ b/site/_includes/footer_contents.html
@@ -0,0 +1,63 @@
+<div class="row">
+ <div class="col-sm-9">
+ <h1>More Resources</h1>
+ <div class="row">
+ <div class="col-sm-4">
+ <h2>General</h2>
+ <ul class="nav">
+ <li>
+ <a target="_blank" href="https://www.automotivelinux.org/">AGL Developer Community</a>
+ </li>
+ <li>
+ <a href="https://www.automotivelinux.org/software/download/">Download Distribution</a>
+ </li>
+ <li>
+ <a href="https://gerrit.automotivelinux.org/gerrit/#/admin/projects/">Source Code on Git</a>
+ </li>
+ <li>
+ <a target="_blank" href="/contact">Mailing List</a>
+ </li>
+ </ul>
+ </div>
+ <div class="col-sm-4">
+ <h2>Development</h2>
+ <ul class="nav">
+ <li><a target="_blank" href="https://wiki.automotivelinux.org/agl-distro/source-code">Source Code</a></li>
+ <li><a target="_blank" href="https://jira.automotivelinux.org/browse/SPEC/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel">Issue Tracker</a></li>
+ <li><a target="_blank" href="https://wiki.automotivelinux.org/">Wiki</a></li>
+ <li><a href="https://www.automotivelinux.org/contact-us">Contact</a></li>
+ </ul>
+ </div>
+ <div class="col-sm-4">
+ <h2>Automotive Grade Linux @ Linux Foundation</h2>
+ <ul class="nav">
+ <li>
+ <a target="_blank" href="https://www.automotivelinux.org/">About AGL</a>
+ </li>
+ <li>
+ <a target="_blank" href="http://www.linuxfoundation.org/">About Linux Foundation</a>
+ </li>
+ <li>
+ <a target="_blank" href="https://wiki.automotivelinux.org/start/getting-started">Join AGL community</a>
+ </li>
+ <li>
+ <a target="_blank" href="https://www.automotivelinux.org/about/members">Members</a>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </div>
+ <div class="col-sm-3">
+ <h1>Contribute</h1>
+ <p style="padding-top:20px"><strong>Help AGL move forward!</strong></p>
+ <p>Report bugs, improve the docs, or contribute to the code.</p>
+ <a href="{{ site.baseurl }}/contribute" class="btn btn-lg btn-primary">
+ Learn More
+ </a>
+ <p style="padding-top:20px"> <a href="https://twitter.com/{{ site.twitter.hashtag }}" class="twitter-follow-button" data-show-count="false">Follow @{{ site.twitter.hashtag }}</a></p>
+ </div>
+</div>
+<p class="copyright_text">
+ Copyright &copy; 2016 Automotive Grade Linux Documentation, Licensed under the <a target="_blank" href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.<br/>
+ Automotive Grade Linux and feather logos are <a target="_blank" href="http://www.linuxfoundation.org">trademarks</a> of The Linux Foundation.
+</p>
diff --git a/site/_includes/footer_docs.html b/site/_includes/footer_docs.html
new file mode 100644
index 0000000..68c6a5c
--- /dev/null
+++ b/site/_includes/footer_docs.html
@@ -0,0 +1,6 @@
+<div class="blue-divider"></div>
+<footer>
+ <div class="container-fluid">
+ {% include footer_contents.html %}
+ </div>
+</footer>
diff --git a/site/_includes/footer_site.html b/site/_includes/footer_site.html
new file mode 100644
index 0000000..4b7fb1d
--- /dev/null
+++ b/site/_includes/footer_site.html
@@ -0,0 +1,6 @@
+<div class="blue-divider"></div>
+<footer>
+ <div class="container">
+ {% include footer_contents.html %}
+ </div>
+</footer>
diff --git a/site/_includes/generated_index.html b/site/_includes/generated_index.html
new file mode 100644
index 0000000..630e7a1
--- /dev/null
+++ b/site/_includes/generated_index.html
@@ -0,0 +1,39 @@
+{% assign tocsdir = site.data.tocs %}
+{% assign tocfile = tocsdir.[page.tocdir].[page.tocfile] %}
+
+<div class="home">
+ {% for entry in tocfile %}
+ <h1>{{ entry.name }}</h1>
+ <ul>
+ {% for child in entry.children %}
+
+ {% comment %}
+ skip sub-sections; they'll get their own sections below
+ {% endcomment %}
+ {% if child.children %}{% continue %}{% endif %}
+
+ <li>
+ <h2><a href="{{ child.url }}">{{ child.name }}</a></h2>
+ {% if child.description %}<span class="summary">{{ child.description }}</span>{% endif %}
+ </li>
+ {% endfor %}
+ </ul>
+
+ {% comment %}
+ add sections for sub-sections
+ {% endcomment %}
+ {% for child in entry.children %}
+ {% if child.children %}
+ <h2>{{ child.name }}</h2>
+ <ul>
+ {% for grandchild in child.children %}
+ <li>
+ <h2><a href="{{ grandchild.url }}">{{ grandchild.name }}</a></h2>
+ {% if grandchild.description %}<span class="summary">{{ grandchild.description }}</span>{% endif %}
+ </li>
+ {% endfor %}
+ </ul>
+ {% endif %}
+ {% endfor %}
+ {% endfor %}
+</div>
diff --git a/site/_includes/head.html b/site/_includes/head.html
new file mode 100644
index 0000000..8f1523f
--- /dev/null
+++ b/site/_includes/head.html
@@ -0,0 +1,63 @@
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta name="format-detection" content="telephone=no">
+ <meta name="viewport" content="user-scalable=no, initial-scale=1, maximum-scale=1, minimum-scale=1, width=device-width" />
+ <meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else if page.description %}{{ page.description }} {% else %}{{ site.description }}{% endif %}">
+
+ <title>
+ {% if page.title %}
+ {% if page.title_suffix %}
+ {{ page.title }} {{ page.title_suffix }}
+ {% else %}
+ {{ page.title }} {{ site.title_suffix }}
+ {% endif %}
+ {% else %}
+ {{ site.title }}
+ {% endif %}
+ </title>
+
+ <link rel="SHORTCUT ICON" href="{{ site.baseurl }}/favicon.ico"/>
+
+ {% capture canonical_link %}{{ site.url }}{{ site.baseurl }}{{ page.url | replace:'index.html','' }}{% endcapture %}
+
+ {% comment %}
+ Canonical link for docs pages should point to the latest version of the page
+ {% endcomment %}
+ {% if page.version %}
+ {% capture latest_url %}{{ page.url | replace_first: page.version, 'latest' }}{% endcapture %}
+
+ {% if site.data.all-pages contains latest_url %}
+ {% capture canonical_link %}{{ canonical_link | replace_first: page.version, 'latest' }}{% endcapture %}
+ {% endif %}
+ {% endif %}
+
+ <link rel="canonical" href="{{ canonical_link }}">
+
+ <!-- CSS -->
+ <link rel="stylesheet" type="text/css" href="{{ site.baseurl }}/static/styles/main.css">
+ <link rel="stylesheet" type="text/css" href="{{ site.baseurl }}/static/styles/syntax.css">
+ <!-- Algolia Search CSS -->
+ <link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
+
+ <!-- Fonts -->
+ <!-- For attribution information, see www/attributions.html -->
+ <link href='https://fonts.googleapis.com/css?family=Raleway:700,400,300,700italic,400italic,300italic' rel='stylesheet' type='text/css'>
+
+ <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+ <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+ <![endif]-->
+ <script type="text/javascript">
+ var disqus_developer = {{ site.disqus.devmode }}; // this would set it to developer mode
+ </script>
+
+ <!-- JS -->
+ <script defer type="text/javascript" src="{{ site.baseurl }}/static/js/lib/jquery-2.1.1.min.js"></script>
+ <script defer type="text/javascript" src="{{ site.baseurl }}/static/js/lib/bootstrap.min.js"></script>
+<!-- <script defer type="text/javascript" src="{{ site.baseurl }}/static/js/lib/ZeroClipboard.js"></script>-->
+
+ {% include analytics.html %}
+</head>
diff --git a/site/_includes/header.html b/site/_includes/header.html
new file mode 100644
index 0000000..58883c2
--- /dev/null
+++ b/site/_includes/header.html
@@ -0,0 +1,57 @@
+<header>
+ <a class="scroll-point pt-top" name="top"></a>
+ <nav class="navbar navbar-inverse navbar-fixed-top">
+ <div class="container-fluid">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="{{ site.baseurl }}/"><img id="logo_top" src="{{ site.baseurl }}{{ site.logo.navbar }}"/></a>
+ </div>
+ <div id="navbar" class="navbar-collapse collapse">
+ <div class="nav_bar_center">
+ <ul class="nav navbar-nav">
+ <li {% if page.specs_tab %}class="active"{% endif %}>
+ <a href="{{ site.docsurl }}/architecture/en/{{ site.default_linked_docs_version }}/">ArchitectureGuide</a>
+ </li>
+
+ <li {% if page.specs_tab %}class="active"{% endif %}>
+ <a href="{{ site.docsurl }}/quickstart/en/{{ site.default_linked_docs_version }}/">GetStarted</a>
+ </li>
+
+ <li {% if page.appfw_tab %}class="active"{% endif %}>
+ <a href="{{ site.docsurl }}/bindings/en/{{ site.default_linked_docs_version }}/">API&Services</a>
+ </li>
+
+ <li {% if page.appfw_tab %}class="active"{% endif %}>
+ <a href="{{ site.docsurl }}/hardware/en/{{ site.default_linked_docs_version }}/">HardwareSupport</a>
+ </li>
+
+ <li {% if page.blog_tab %}class="active"{% endif %}>
+ <a href="{{ site.baseurl }}/techpost" id="blog_button">TechPost<span class="badge" id="new_blog_count"></span></a>
+ </li>
+ <li {% if page.contribute_tab %}class="active"{% endif %}>
+ <a href="{{ site.baseurl }}/contribute">Contribute</a>
+ </li>
+ <li>
+ <form class="navbar-form navbar-right" id="header-search-form" role="search">
+ <div class="input-group">
+ {% if page.version %}
+ {% assign version = page.version %}
+ {% else %}
+ {% assign version = site.latest_docs_version %}
+ {% endif %}
+ <input id="header-search-field" type="text" placeholder="Search '{{ version }}' docs..." class="form-control hidden-xs" autocomplete="off">
+ </div>
+ </form>
+ </li>
+ </ul>
+ </div>
+ </div><!--/.navbar-collapse -->
+ </div>
+ </nav>
+ <div id="_fixed_navbar_spacer" style="padding-top:50px"></div>
+</header>
diff --git a/site/_includes/sitemap_entry.html b/site/_includes/sitemap_entry.html
new file mode 100644
index 0000000..f20645d
--- /dev/null
+++ b/site/_includes/sitemap_entry.html
@@ -0,0 +1,5 @@
+<url>
+ <loc>{{ site.url }}{{ include.url }}</loc>{% if include.change_frequency %}
+ <changefreq>{{ include.change_frequency }}</changefreq>{% endif %}{% if include.priority %}
+ <priority>{{ include.priority }}</priority>{% endif %}
+</url>
diff --git a/site/_includes/toc_recursive_dropdown.html b/site/_includes/toc_recursive_dropdown.html
new file mode 100644
index 0000000..b0983e1
--- /dev/null
+++ b/site/_includes/toc_recursive_dropdown.html
@@ -0,0 +1,13 @@
+
+{% for entry in include.entries %}
+{% if entry.url != null %}
+<li>
+ <a class="{% if include.my_entry == entry.url %}this-page{% endif %}" href="{{ include.version_root }}{{ entry.url }}">
+ {{ entry.name }}
+ </a>
+</li>
+{% endif %}
+{% if entry.children %}
+{% include toc_recursive_dropdown.html entries=entry.children my_entry=include.my_entry version_root=version_root %}
+{% endif %}
+{% endfor %}
diff --git a/site/_includes/toc_recursive_main.html b/site/_includes/toc_recursive_main.html
new file mode 100644
index 0000000..653a706
--- /dev/null
+++ b/site/_includes/toc_recursive_main.html
@@ -0,0 +1,28 @@
+<ul class="site-toc">
+ {% for entry in include.entries %}
+
+ <li>
+ {% if entry.children %}
+ <span class="toc-section-heading">
+ {{ entry.name }}
+ </span>
+ {% else %}
+ <a class="{% if include.my_entry == entry.url %}this-page{% endif %}" href="{{ include.version_root }}{{ entry.url }}">
+ {{ entry.name }}
+ </a>
+ {% if include.my_entry == entry.url %}
+ <span class="entry-highlight"></span>
+ {% endif %}
+ {% endif %}
+
+ {% comment %}
+ Insert page-specific ToC here if this is the entry for this page
+ {% endcomment %}
+ {% if include.my_entry == entry.url %}<div id="page-toc" class="page-toc"></div>{% endif %}
+
+ {% if entry.children %}
+ {% include toc_recursive_main.html entries=entry.children my_entry=include.my_entry version_root=include.version_root %}
+ {% endif %}
+ </li>
+ {% endfor %}
+</ul>
diff --git a/site/_includes/tools_and_showcase.html b/site/_includes/tools_and_showcase.html
new file mode 100644
index 0000000..d2cfeb4
--- /dev/null
+++ b/site/_includes/tools_and_showcase.html
@@ -0,0 +1,66 @@
+<div class="container">
+ <div class="row showcase_section_intro">
+ <div class="col-md-12 text-center">
+ <h1>Cordova Tools</h1>
+ <h2>A diverse ecosystem of command line tools, JavaScript frameworks, and cloud services exist that augment Cordova</h2>
+ </div>
+ </div>
+ <div class="row card_gallery">
+ {% for tool in site.data.tools %}
+ <div class="col-lg-2 col-md-4 col-sm-6 col-xs-12 card">
+ <div class="tool card_inner">
+ <div class="img_container">
+ <img src="{{ site.baseurl }}/static/img/tools/{{ tool.image }}" class="center-block"/>
+ </div>
+ <p class="card_title">
+ {% if tool.url %}
+ <a href="{{ tool.url }}">
+ {{ tool.name }}
+ </a>
+ {% else %}
+ {{ tool.name }}
+ {% endif %}
+ </p>
+ <p class="text">
+ {{ tool.description | strip_html | truncate:255 }}
+ </p>
+ </div>
+ </div>
+ {% endfor %}
+ </div>
+</div>
+
+<div class="container">
+ <div class="row showcase_section_intro">
+ <div class="col-md-12 text-center">
+ <h1>Cordova App Showcase</h1>
+ <h2>See other apps that use Cordova</h2>
+ </div>
+ </div>
+ <div class="row card_gallery">
+ {% for app in site.data.showcase-apps %}
+ <div class="col-lg-2 col-md-4 col-sm-6 col-xs-12 card">
+ <div class="app card_inner">
+ <div class="showcase_app_thumb">
+ <img src="{{ site.baseurl }}/static/img/showcase-apps/{{ app.image }}" class="center-block"/>
+ </div>
+ <p class="card_title">
+ {% if app.url %}
+ <a href="{{ app.url }}">
+ {{ app.name }}
+ </a>
+ {% else %}
+ {{ app.name }}
+ {% endif %}
+ </p>
+ <p class="text">{{ app.description | strip_html | truncate:128 }}</p>
+ </div>
+ </div>
+ {% endfor %}
+ </div>
+ <div class="row">
+ <p>
+ &nbsp;
+ </p>
+ </div>
+</div>
diff --git a/site/_includes/twitterFeed.html b/site/_includes/twitterFeed.html
new file mode 100644
index 0000000..1fde3ab
--- /dev/null
+++ b/site/_includes/twitterFeed.html
@@ -0,0 +1,20 @@
+<a class="twitter-timeline" data-dnt="true" href="https://twitter.com/{{ site.twitter.hashtag }}" data-widget-id="{{ site.twitter.widgetid }}">Tweets by @@{{ site.twitter.hashtag }}</a>
+
+<script>
+window.twttr = (function(d, s, id) {
+ var js, fjs = d.getElementsByTagName(s)[0],
+ t = window.twttr || {};
+ if (d.getElementById(id)) return t;
+ js = d.createElement(s);
+ js.id = id;
+ js.src = "https://platform.twitter.com/widgets.js";
+ fjs.parentNode.insertBefore(js, fjs);
+
+ t._e = [];
+ t.ready = function(f) {
+ t._e.push(f);
+ };
+
+ return t;
+}(document, "script", "twitter-wjs"));
+</script>