jekyll-theme-docs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ba58b192782936f9d4994322fc29d35a0dfabdc
+  data.tar.gz: 532177782733a58545a6015274715c1a175df799
+SHA512:
+  metadata.gz: 2b4d7119b41d9bcb1ea9e0829914a2965c65feb5181cb5c5a07727317abefe2341950a3dddcd2566b5325c9236671e3d82ae159ac235933e6bf0f25d5bb7152c
+  data.tar.gz: 30c18cfc92dba7e9125d28c85370c270198b218ecac6f5ec2c71e0338b5b86e65642a56aa5d98fb69d1fbc05fe10d746d7d747cf99597913d36ad4a94a2995ec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Natan Felles
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,2 @@
+# jekyll-theme-docs.github.io
+Jekyll Theme Docs

data/_includes/breadcrumbs.html

@@ -0,0 +1,55 @@
+{% if page.layout == 'category' %}
+	<ol class="breadcrumb">
+		<li>
+			<a href="{{ 'docs' | relative_url }}">
+				{% for site_pages in site.pages %}
+					{% if site_pages.url == '/docs/' %}
+						{{ site_pages.title }}
+					{% endif %}
+				{% endfor %}
+			</a>
+		</li>
+		<li class="active">{{ page.title }}</li>
+	</ol>
+{% elsif page.layout == 'subcategory' %}
+	<ol class="breadcrumb">
+		<li>
+			<a href="{{ 'docs' | relative_url }}">
+				{% for site_pages in site.pages %}
+					{% if site_pages.url == '/docs/' %}
+						{{ site_pages.title }}
+					{% endif %}
+				{% endfor %}
+			</a>
+		</li>
+		{% assign category_url = '/docs' %}
+		{% for category in page.categories %}
+			{% capture category_url %}{{ category_url}}/{{ category }}{% endcapture %}
+			{% capture cat_url %}{{ category_url}}/{% endcapture %}
+			<li>
+				{% for site_pages in site.pages %}
+					{% if site_pages.url == cat_url %}
+						<a href="{{ site_pages.url }}">{{ site_pages.title }}</a>
+					{% endif %}
+				{% endfor %}
+			</li>
+		{% endfor %}
+		<li class="active">{{ page.title }}</li>
+	</ol>
+{% elsif page.layout == 'post' %}
+	<ol class="breadcrumb">
+		{% assign category_url = '' %}
+		{% for category in page.categories %}
+			{% capture category_url %}{{ category_url}}/{{ category }}{% endcapture %}
+			{% capture cat_url %}{{ category_url}}/{% endcapture %}
+			<li>
+				{% for site_pages in site.pages %}
+					{% if site_pages.url == cat_url %}
+						<a href="{{ site_pages.url }}">{{ site_pages.title }}</a>
+					{% endif %}
+				{% endfor %}
+			</li>
+		{% endfor %}
+		<li class="active">{{ page.title }}</li>
+	</ol>
+{% endif %}

data/_includes/disqus.html

@@ -0,0 +1,18 @@
+{% if site.disqus_shortname %}
+    <div id="disqus_thread"></div>
+    <script type="text/javascript">
+      var disqus_config = function () {
+        this.page.url = '{{ site.url }}{{ page.url }}';
+        this.page.identifier = '{{ page.id }}';
+      };
+
+      (function() {
+        var d = document, s = d.createElement('script');
+        s.src = '//{{ site.disqus_shortname }}.disqus.com/embed.js';
+        s.setAttribute('data-timestamp', +new Date());
+        (d.head || d.body).appendChild(s);
+       })();
+    </script>
+    <noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
+    <a href="http://disqus.com" class="dsq-brlink" target="_blank">comments powered by <span class="logo-disqus">Disqus</span></a></a>
+{% endif %}

data/_includes/footer.html

@@ -0,0 +1,28 @@
+<button class="btn btn-default btn-lg" id="toTop"><i class="fa fa-chevron-up"></i></button>
+
+<footer>
+	<div class="container text-center">
+		<p>Theme created with
+			<i class="fa fa-heart"></i>
+			<i class="fa fa-music"></i>
+			<i class="fa fa-coffee"></i>
+			and <i class="fa fa-linux"></i>
+			by <a href="https://natanfelles.github.io" target="_blank">Natan Felles</a>
+			to <a href="https://jekyllrb.com/" target="_blank">Jekyll Community</a>
+		</p>
+	</div>
+</footer>
+
+{% include google-analytics.html  %}
+
+{% if jekyll.environment != "development" %}
+	<script src="https://code.jquery.com/jquery-2.2.4.min.js" integrity="sha256-BbhdlvQf/xTY9gja0Dq3HiwQF8LaCRTXxZKRutelT44=" crossorigin="anonymous"></script>
+	<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>
+	<script src="https://cdnjs.cloudflare.com/ajax/libs/1000hz-bootstrap-validator/0.11.9/validator.min.js" integrity="sha256-dHf/YjH1A4tewEsKUSmNnV05DDbfGN3g7NMq86xgGh8=" crossorigin="anonymous"></script>
+{% else %}
+	<script type="text/javascript" src="{{ "/assets/js/jquery.min.js" | relative_url }}"></script>
+	<script type="text/javascript" src="{{ "/assets/js/bootstrap.min.js" | relative_url }}"></script>
+	<script type="text/javascript" src="{{ "/assets/js/validator.min.js" | relative_url }}"></script>
+{% endif %}
+
+<script type="text/javascript" src="{{ "/assets/js/scripts.js" | relative_url }}"></script>

data/_includes/google-analytics.html

@@ -0,0 +1,11 @@
+{% if site.google.analytics %}
+	<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','https://www.google-analytics.com/analytics.js','ga');
+
+	  ga('create', '{{ site.google.analytics }}', 'auto');
+	  ga('send', 'pageview');
+	</script>
+{% endif %}

data/_includes/head.html

@@ -0,0 +1,20 @@
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>{{ site.title }}{% if page.title %} · {{ page.title }}{% endif %}</title>
+  <meta name="author" content="{% if page.author.name %}{{ page.author.name }}{% else %}{{ site.author.name }}{% endif %}">
+
+  {% include  meta_social.html %}
+
+  <link rel="apple-touch-icon" href="{{ "/assets/img/apple-touch-icon.png" | relative_url }}">
+  <link rel="icon" type="image/png" href="{{ "/assets/img/favicon.png" | relative_url }}">
+  <link rel="shortcut icon" href="{{ "/favicon.ico" | relative_url }}">
+
+  <link rel="stylesheet" href="{{ "/assets/css/bootstrap.min.css" | relative_url }}">
+  <link rel="stylesheet" href="{{ "/assets/css/font-awesome.min.css" | relative_url }}">
+
+  <link rel="stylesheet" href="{{ "/assets/css/styles.css" | relative_url }}">
+
+  <link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ "/feed.xml" | relative_url }}">
+</head>

data/_includes/header.html

@@ -0,0 +1,22 @@
+<header>
+  <nav class="navbar navbar-default navbar-inverse">
+    <div class="container">
+      <div class="navbar-header">
+        <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#header-collapse" aria-expanded="false">
+          <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.url }}">{{ site.title }}</a>
+      </div>
+      <div class="collapse navbar-collapse" id="header-collapse">
+        <ul class="nav navbar-nav navbar-right">
+          <li><a href="{{ 'docs' | relative_url }}">Docs</a></li>
+          <li><a href="{{ 'about' | relative_url }}">About</a></li>
+          <li><a href="{{ 'contact' | relative_url }}">Contact</a></li>
+        </ul>
+      </div>
+    </div>
+  </nav>
+</header>

data/_includes/meta_social.html

@@ -0,0 +1,49 @@
+{% capture title %}{% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}{% endcapture %}
+{% capture description %}{% if page.description %}{{ page.description }}{% else %}{{ site.description }}{% endif %}{% endcapture %}
+{% capture keywords %}{% if page.keywords %}{{ page.keywords }}{% else %}{{ site.keywords }}{% endif %}{% endcapture %}
+{% capture twitter_site %}{% if page.twitter.site %}{{ page.twitter.site }}{% else %}{{ site.twitter.site }}{% endif %}{% endcapture %}
+{% capture twitter_creator %}{% if page.twitter.creator %}{{ page.twitter.creator }}{% else %}{{ site.twitter.creator }}{% endif %}{% endcapture %}
+{% capture image %}{% if page.image %}{{ page.image }}{% else %}{{ site.image }}{% endif %}{% endcapture %}
+
+<meta name="description" content="{{ description }}">
+<meta name="keywords" content="{{ keywords }}">
+
+<!-- Twitter -->
+{% if twitter_site != ''  %}
+<meta name="twitter:site" content="{{ twitter_site }}">
+{% endif %}
+
+{% if twitter_creator != '' %}
+<meta name="twitter:creator" content="{{ twitter_creator }}">
+{% endif %}
+
+<meta name="twitter:title" content="{{ title }}">
+<meta name="twitter:description" content="{{ description }}">
+<meta name="twitter:image" content="{{ image }}">
+<meta name="twitter:url" content="{{ page.url }}"/>
+<meta name="twitter:card" content="photo" />
+
+<!-- Facebook -->
+<meta name="og:url" content="{{ page.url }}">
+<meta name="og:site_name" content="{{ site.title }}">
+<meta name="og:title" content="{{ title }}">
+<meta name="og:description" content="{{ description }}">
+<meta name="og:image" content="{{ image }}">
+{% capture og_type %}{% if page.layout == "post" %}article{% else %}website{% endif %}{% endcapture %}
+<meta name="og:type" content="{{ og_type }}">
+
+<!-- Google Verification and Analytics -->
+{% if site.google.site-verification  %}
+<meta name="google-site-verification" content="{{ site.google.site-verification }}">
+{% endif %}
+
+{% if site.google.analytics  %}
+<meta name="google-analytics" content="{{ site.google.analytics }}">
+{% endif %}
+
+<!-- Custom -->
+<meta name="google-cse-cx" content="{{ site.google.cse-cx }}">
+<meta name="google-api-key" content="{{ site.google.api-key }}">
+
+<link rel="canonical" href="{{ page.url }}">
+

data/_includes/search.html

@@ -0,0 +1,38 @@
+<form id="search-form">
+	<div class="input-group">
+	  <input type="text" name="q" class="form-control" placeholder="Search for...">
+	  <span class="input-group-btn">
+	    <button class="btn btn-default" type="submit" data-toggle="modal" data-target="#search-results"><i class="fa fa-search"></i></button>
+	  </span>
+	</div>
+</form>
+
+<div class="modal fade" id="search-results">
+	<div class="modal-dialog modal-lg">
+		<div class="modal-content">
+			<div class="modal-header">
+				<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
+				<h4 class="modal-title">Search powered by Google CSE</h4>
+			</div>
+			<div class="modal-body">
+				<form id="search-modal">
+					<div class="form-group">
+						<div class="input-group">
+					      <input type="text" name="q" class="form-control" placeholder="Search for...">
+					      <span class="input-group-btn">
+					        <button class="btn btn-default" type="submit"><i class="fa fa-search"></i></button>
+					      </span>
+					    </div>
+					</div>
+				</form>
+				<div id="search-box">
+					<p class="text-muted text-right sr-benchmark"><!-- ajax --></p>
+					<div class="list-group sr-results"><!-- ajax --></div>
+					<nav class="text-center sr-pages">
+						<ul class="pagination"><!-- ajax --></ul>
+					</nav>
+				</div>
+			</div>
+		</div>
+	</div>
+</div>

data/_includes/sidebar.html

@@ -0,0 +1,29 @@
+<aside class="col-md-3" id="sidebar">
+	<div class="well">
+		{% include search.html %}
+	</div>
+	<div class="list-group" id="topics"><!-- Topics --></div>
+	<div class="well">
+		<form>
+			<label>Subscribe to Updates</label>
+			<div class="input-group">
+		      <input type="email" class="form-control" placeholder="Email address...">
+		      <span class="input-group-btn">
+		        <button class="btn btn-default" type="button">Ok</button>
+		      </span>
+		    </div>
+		</form>
+	</div>
+
+	{% if page.tags[0] %}
+		<div class="panel panel-default" id="tags">
+		  <div class="panel-heading">Tags</div>
+		  <div class="panel-body">
+		    {% for tag in page.tags %}
+		    	<a class="btn btn-default" href="{{ /tags#{{tag}} }}">{{ tag }}</a>
+		    {% endfor %}
+		  </div>
+		</div>
+	{% endif %}
+
+</aside>

data/_layouts/category.html

@@ -0,0 +1,50 @@
+---
+layout: default
+---
+<div class="container">
+
+	<div class="row">
+		<div class="col-md-8">
+			{% include breadcrumbs.html %}
+		</div>
+		<div class="col-md-4">
+			{% include search.html %}
+		</div>
+	</div>
+
+	<h1>{{ page.title }}</h1>
+	<p>{{ page.description }}</p>
+
+	<div class="content">{{ content }}</div>
+
+	<div class="list-group posts">
+		{% capture page_base %}/{{ page.path | remove: page.name}}{% endcapture %}
+		{% for post in site.posts  %}
+			{% capture post_base %}{{ post.url | remove: post.slug }}{% endcapture %}
+			{% if post_base == page_base %}
+				<a href="{{ post.url  }}" class="list-group-item">
+					<h4 class="list-group-item-heading">{{ post.title }}</h4>
+					<p class="list-group-item-text">{{ post.description }}</p>
+				</a>
+			{% endif %}
+		{% endfor %}
+	</div>
+
+	{% for category in page.categories %}
+		{% capture category_url %}{{ page.url }}{{ category }}/{% endcapture %}
+		{% for site_pages in site.pages %}
+			{% if site_pages.url == category_url %}
+				<h2><a href="{{ site_pages.url }}">{{ site_pages.title }}</a></h2>
+				<p>{{ site_pages.description }}</p>
+			{% endif %}
+		{% endfor %}
+		<div class="list-group posts">
+			{% for post in site.posts  %}
+				{% if post.url contains category_url %}
+					<a href="{{ post.url  }}" class="list-group-item">{{ post.title }}</a>
+				{% endif %}
+			{% endfor %}
+		</div>
+	{% endfor %}
+
+</div>

data/_layouts/default.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html lang="{% if page.lang %}{{ page.lang }}{% else %}{{ site.lang }}{% endif %}">
+  {% include head.html %}
+  <body>
+  	{% include header.html %}
+  	{{ content }}
+	{% include footer.html %}
+  </body>
+</html>

data/_layouts/post.html

@@ -0,0 +1,76 @@
+---
+layout: default
+---
+<div class="container">
+
+	{% include breadcrumbs.html %}
+
+	<div class="row">
+
+		{% include sidebar.html %}
+
+		<div class="col-md-9">
+			<h1 class="main-header">{{ page.title }}</h1>
+
+			<p class="text-muted">
+				{% if page.update.date %}
+					Updated {{ page.update.date | date_to_long_string }} by {% if page.update.author %}{{ page.update.author }}{% else %}{{ page.author }}{% endif %}
+				{% else %}
+					Created {{ page.date | date_to_long_string }} by {% if page.author.name %}{{ page.author.name }}{% else %}{{ site.author.name }}{% endif %}
+				{% endif %}
+			</p>
+
+			<div class="github-block well">
+				<p>
+					<strong><i class="fa fa-github"></i> Contribute on GitHub</strong>
+					<a href="https://github.com/{{ site.github.repository_nwo }}" target="_blank">View Project</a> |
+					<a href="https://github.com/{{ site.github.repository_nwo }}/blob/{{ site.branch }}/{{ page.path }}" target="_blank">View File</a> |
+					<a href="https://github.com/{{ site.github.repository_nwo }}/edit/{{ site.branch }}/{{ page.path }}" target="_blank">Edit File</a>
+				</p>
+			</div>
+
+			<div class="post">
+				{{ content }}
+			</div>
+
+			{% if page.external_resources %}
+				<div class="external_resources">
+					<h2>External Resources</h2>
+					<ul>
+						{% for item in page.external_resources  %}
+							{% capture link %}{{ item }}{: target="_blank"}{% endcapture %}
+							<li>{{ link | markdownify }}</li>
+						{% endfor %}
+					</ul>
+				</div>
+			{% endif %}
+
+			<hr>
+			{% if page.license %}
+				<p class="text-muted">
+					{% capture page_license %}{{ page.license }}{: target="_blank"}{% endcapture %}
+					This guide is published under a {{ page_license | markdownify | remove: '<p>' | remove: '</p>' }} license.
+				</p>
+			{% endif %}
+
+			<div class="text-center prev_next">
+				<div class="btn-group btn-group-justified" role="group">
+					{% if page.previous.url %}
+						<a href="{{ page.previous.url }} " class="btn btn-default">
+							<i class="fa fa-arrow-left"></i> Previous Post
+						</a>
+					{% endif %}
+					{% if page.next.url %}
+						<a href="{{ page.next.url }} " class="btn btn-default">
+							Next Post <i class="fa fa-arrow-right"></i>
+						</a>
+					{% endif %}
+				</div>
+			</div>
+
+			{% include disqus.html %}
+
+		</div>
+
+	</div>
+</div>