Skip to content

Commit

Permalink
Initial version of openHAB 2 documentation website
Browse files Browse the repository at this point in the history
Signed-off-by: Kai Kreuzer <[email protected]>
  • Loading branch information
kaikreuzer committed May 14, 2016
0 parents commit f4a5874
Show file tree
Hide file tree
Showing 51 changed files with 18,086 additions and 0 deletions.
1 change: 1 addition & 0 deletions CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs.openhab.org
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
This repository contains the documentation for openHAB.

The result is available at http://docs.openhab.org/
11 changes: 11 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Site settings
title: openHAB
description: Open Source Smart Home Solution
baseurl: "" # the subpath of your site, e.g. /blog/
url: "http://docs.openhab.org" # the base hostname & protocol for your site
twitter_username: openhab
github_username: openhab
source: src

# Build settings
markdown: kramdown
8 changes: 8 additions & 0 deletions src/_includes/base.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{% assign base = '' %}
{% assign depth = page.url | split: '/' | size | minus: 1 %}
{% if depth == 0 %}{% assign base = '.' %}
{% elsif depth == 1 %}{% assign base = '..' %}
{% elsif depth == 2 %}{% assign base = '../..' %}
{% elsif depth == 3 %}{% assign base = '../../..' %}
{% elsif depth == 4 %}{% assign base = '../../../..' %}
{% elsif depth == 5 %}{% assign base = '../../../../..' %}{% endif %}
45 changes: 45 additions & 0 deletions src/_includes/documentation-menu.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
{% include base.html %} {% assign docu = base %}

<ul class="nav">
<li><a href="{{docu}}/index.html">Overview</a></li>
<li><a href="{{docu}}/concepts-esh/items.html">Concepts</a>
<ul>
<li><a href="{{docu}}/concepts-esh/items.html">Items</a></li>
<li><a href="{{docu}}/concepts-esh/things.html">Things</a></li>
<li><a href="{{docu}}/concepts-esh/discovery.html">Inbox & Discovery</a></li>
<li><a href="{{docu}}/concepts-esh/events.html">Events</a></li>
</ul>
</li>
<li><a href="{{docu}}/features/index.html">Add-ons</a>
<ul>
<li><a href="{{docu}}/features/bindings/hue/readme.html">Bindings</a>
<ul>
<li><a href="{{docu}}/features/bindings/digitalstrom/readme.html">digitalSTROM</a></li>
<li><a href="{{docu}}/features/bindings/hue/readme.html">Philips Hue</a></li>
<li><a href="{{docu}}/features/bindings/fsinternetradio/readme.html">FS Internet Radio</a></li>
<li><a href="{{docu}}/features/bindings/lifx/readme.html">LIFX</a></li>
<li><a href="{{docu}}/features/bindings/ntp/readme.html">NTP Time Server</a></li>
<li><a href="{{docu}}/features/bindings/wemo/readme.html">Belkin Wemo</a></li>
<li><a href="{{docu}}/features/bindings/yahooweather/readme.html">Yahoo Weather</a></li>
</ul>
</li>
<li><a href="{{docu}}/features/ui/icons.html">User Interfaces</a>
<ul>
<li><a href="{{docu}}/features/ui/icons.html">Icon Support</a></li>
<li><a href="{{docu}}/features/ui/paperui.html">Paper UI</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="{{docu}}/development/ide.html">Development</a>
<ul>
<li><a href="{{docu}}/development/ide.html">IDE Setup</a></li>
<li><a href="{{docu}}/development/guidelines.html">Guidelines</a></li>
<li><a href="{{docu}}/development/bindings.html">Bindings</a></li>
</ul></li>
<li><a href="{{docu}}/community/contributing.html">Community</a>
<ul>
<li><a href="{{docu}}/community/contributing.html">Contributing</a></li>
<li><a href="{{docu}}/community/downloads.html">Downloads</a></li>
</ul></li>
</ul>
47 changes: 47 additions & 0 deletions src/_includes/footer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
{% include base.html %}

<footer class="page-footer">
<div class="footer-copyright">
<div class="container center">
Copyright 2016, openHAB.org
</div>
</div>
</footer>

<script src="https://www.eclipse.org/smarthome/js/jquery.min.js"></script>
<script src="https://www.eclipse.org/smarthome/js/jquery.scrollme.min.js"></script>
<script src="https://www.eclipse.org/smarthome/js/jquery.sticky.js"></script>
<script src="//www.eclipse.org/smarthome/js/materialize.js"></script>
<script src="https://www.eclipse.org/smarthome/js/highlight.pack.js"></script>
<script src="{{base}}/js/init.js"></script>
<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>

<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', 'UA-55850963-1', 'auto');
ga('send', 'pageview');

</script>
</body>
</html>
18 changes: 18 additions & 0 deletions src/_includes/gettingstarted-menu.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{% include base.html %} {% assign docu = base %}

<ul class="nav">
<li><a href="{{docu}}/index.html">openHAB Basics</a>
<ul>
<li><a href="{{docu}}/index.html">Things, Items & Co</a></li>
<li><a href="{{docu}}/index.html">Sitemaps</a></li>
<li><a href="{{docu}}/index.html">Add-ons</a></li>
</ul>
</li>
<li><a href="{{docu}}/index.html">Installing openHAB</a>
<ul>
<li><a href="{{docu}}/index.html">Java</a></li>
<li><a href="{{docu}}/index.html">Runtime</a></li>
<li><a href="{{docu}}/index.html">Designer</a></li>
</ul>
</li>
</ul>
45 changes: 45 additions & 0 deletions src/_includes/header.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
{% include base.html %}
<!--<link rel="shortcut icon" href="https://www.openhab.org/favicon.png"></link>-->
<title>openHAB - Empowering the Smart Home</title>

<!-- CSS -->
<link href="{{base}}/css/materialize.css" type="text/css" rel="stylesheet"
media="screen,projection" />
<link href="{{base}}/css/highlight.github.css" type="text/css" rel="stylesheet"
media="screen,projection" />
<link href="{{base}}/css/styles.css" rel="stylesheet" />

<!-- Font -->
<link href='https://fonts.googleapis.com/css?family=Lato:300,400,700'
rel='stylesheet' type='text/css' />

</head>
<body class="{{ include.bodyClass }}">
<div id="header" class="navbar-fixed">
<nav role="navigation">
<div class="container">
<div class="nav-wrapper">
<a href="{{base}}/index.html"><img id="logo" src="/images/logo.png" /></a>
<a href="#" data-activates="nav-mobile" class="button-collapse"><i
class="mdi-navigation-menu"></i></a>
<ul class="right hide-on-med-and-down">
<li><a href="{{base}}/getting-started.html">Getting Started</a></li>
<li><a href="{{base}}/index.html">Documentation</a></li>
<li><a href="https://github.com/openhab/openhab-distro">GitHub</a></li>
</ul>
<ul id="nav-mobile" class="side-nav">
<li><a href="{{base}}/index.html">Home</a></li>
<li><a href="{{base}}/getting-started.html">Getting Started</a></li>
<li><a href="{{base}}/index.html">Documentation</a></li>
<li><a href="https://github.com/openhab/openhab-distro">GitHub</a></li>
</ul>
</div>
</div>
</nav>
</div>
14 changes: 14 additions & 0 deletions src/_layouts/documentation.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{% include header.html bodyClass="documentation"%}

<section id="documentation" class="text content-wrapper">
<div class="container">
<div class="side-nav-wrapper">
{% include documentation-menu.html %}
</div>
<div class="content">
{{ content }}
</div>
</div>
</section>

{% include footer.html %}
13 changes: 13 additions & 0 deletions src/_layouts/gettingstarted.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{% include header.html bodyClass="documentation"%}

<section id="documentation" class="text content-wrapper">
<div class="container">
<div class="side-nav-wrapper">
{% include gettingstarted-menu.html %}
</div>
<div class="content">
{{ content }}
</div>
</div>
</section>

Loading

0 comments on commit f4a5874

Please sign in to comment.