jekyll-octopod 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38dd403316e5bbd5e7f7832da809f30a39f31e9e
-  data.tar.gz: 3443307d1ebff4d848449609d76c0c9bd60ed556
+  metadata.gz: 782f2b1a22fcd2f780a9a6b92ba4911416ddebe4
+  data.tar.gz: fe5a3d6764610d468e2a5feea7be3756bea0f6b7
 SHA512:
-  metadata.gz: 736b43cbd02a3a1db6b2c476c8f3291e7ad156a8eb7ed02372fc6985629ccb4abeda2b62ebb14c5e60b1616e967f4274acd9dcb4f3f947a07d0880744813a9d4
-  data.tar.gz: 8cc2e80bde2b454b5aeef7e5630ce71e25b73cb9bceb9ad772a932195e77707ee3769fd2c1e54c5bd17e9826a04eb61ab81b5967fc4388c9c26e9bada20b863b
+  metadata.gz: 98883f1872ef175c39866c95fae9ce7bc80d1833b2cc769eb4938fa05e10f7cc0ec90506ac869a479cb6fc4d9e5a862f937f13ae12092bdfcb0d3ccfd40a5ee4
+  data.tar.gz: 8bfeb74bebb51c2cb54d0e8b694e072a30bc4e7c7f29d589b06eab886b88e06d0f9fc9c9a004525d46d52f1fe4c4a7f53c46c74d770605d53dea76a64b27f267

data/README.md

@@ -1,5 +1,7 @@
 # Jekyll - Octopod
 
+[![Gem Version](https://badge.fury.io/rb/jekyll-octopod.svg)](https://badge.fury.io/rb/jekyll-octopod)
+
 <img align="right" src="assets/img/logo.jpg" alt="logo">
 A podcast publishing extension for the static site generator [Jekyll](https://jekyllrb.com/)
 
@@ -16,7 +18,7 @@ If you want to take a look: See (and listen to) Stefan's podcast [Aua-Uff-Code!]
 
 The page, you will get, when you follow the installation instructions later, looks like this:
 
-![sreenshot](materials/demo.png)
+![screenshot](materials/demo.png)
 
 Technically speaking, jekyll-octopod is a Jekyll plugin and a Ruby Gem. It
 contains of scripts, templates, helpers and extensions to publish your
@@ -65,3 +67,5 @@ Detailed documentation is provided in the [Wiki](https://github.com/informatom/j
 ## Maintainer
 
 Stefan Haslinger <mailto:stefan.haslinger@informatom.com>
+
+Credits go to lots of [people and projects](https://github.com/informatom/jekyll-octopod/wiki/Credits).

data/assets/_config.yml.sample

@@ -0,0 +1,47 @@
+# You have to configure this ###################################################
+title: Octopod
+# You should configure this ####################################################
+url: http://localhost:4000
+subtitle: Static Site Podcast Publishing for Geeks
+description: My super duper cool podcast.
+author: Uncle Octopod
+email: octopod@example.com
+keywords: [octopod, podcast, magic]
+itunes_categories: [Technology]
+# additional_feeds:
+#   itunes: http://itunes.apple.com/de/podcast/podcast_name/id42424242
+#   torrent_m4a: http://bitlove.org/example_user/example_podcast_m4a/feed
+#   torrent_mp3: http://bitlove.org/example_user/example_podcast_mp3/feed
+## podlove-web-palyer ##########################################################
+poster: /img/logo-360x360.png
+alwaysShowHours: true
+startVolume: 0.8
+width: auto
+summaryVisible: false
+timecontrolsVisible: false
+chaptersVisible: true
+sharebuttonsVisible: false
+## Rsync Deploy config #########################################################
+### Be sure your public key is listed in your server's ~/.ssh/authorized_keys
+### file.
+ssh_host: user@host.org
+ssh_port: 22
+document_root: /path/to/your/htdocs/
+rsync_delete: true
+# You can configure this #######################################################
+twitter_nick: my_twitter_handle
+language: en
+explicit: 'no'  # 'yes'/'no'/clean
+license: CC BY 4.0
+## Flattr ######################################################################
+flattr_uid: # Flattr will not be used unless this is set
+flattr_button: compact # compact | default
+flattr_mode: auto # auto | manual(default)
+flattr_popout:  1 # 1 | 0 (show popout when hovering mouse over button)
+flattr_language: en_GB # available languages - https://api.flattr.com/rest/v2/languages.txt
+flattr_category: audio # available categories - https://api.flattr.com/rest/v2/categories.txt
+## Disqus comments #############################################################
+disqus_shortname: # Disqus will not be used unless this is set
+disqus_developer: 0 # 1 / 0
+## Itunes link ###########################################################
+itunes_url: "https://itunes.apple.com/at/podcast/myname/id#myid#"

data/assets/_includes/disqus_count.html

@@ -0,0 +1,13 @@
+{% if site.disqus_shortname %}
+<a class="btn btn-inverse pull-right" href="{{ site.url }}{{ post.url }}#disqus_thread">
+<script type="text/javascript">
+  (function () {
+    {{ site | disqus_config:post }}
+    var s = document.createElement('script'); s.async = true;
+    s.type = 'text/javascript';
+    s.src = 'https://{{ site.disqus_shortname }}.disqus.com/count.js';
+    (document.getElementsByTagName('HEAD')[0] || document.getElementsByTagName('BODY')[0]).appendChild(s);
+  }());
+</script>
+</a>
+{% endif %}

data/assets/_includes/disqus_thread.html

@@ -0,0 +1,13 @@
+{% if site.disqus_shortname %}
+<div id="disqus_thread"></div>
+<script type="text/javascript">
+  {{ site | disqus_config:post }}
+  (function() {
+    var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
+    dsq.src = 'https://{{ site.disqus_shortname }}.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">comments powered by Disqus.</a></noscript>
+<a href="https://disqus.com" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>
+{% endif %}

data/assets/_includes/flattr_loader.html

@@ -0,0 +1,14 @@
+<script type="text/javascript">
+/* <![CDATA[ */
+(function() {
+    var s = document.createElement('script');
+    var t = document.getElementsByTagName('script')[0];
+
+    s.type = 'text/javascript';
+    s.async = true;
+    s.src = '//api.flattr.com/js/0.6/load.js?{{ site | flattr_loader_options }}';
+
+    t.parentNode.insertBefore(s, t);
+ })();
+/* ]]> */
+</script>

data/assets/_includes/post.html

@@ -0,0 +1,18 @@
+{% if post %}
+{% elsif page %}
+  {% assign post = page %}
+{% endif %}
+<section id="{{ post.id | sha1:8 }}" class="active">
+  {% include post_header.html %}
+  {{ post.content }}
+    {% if post.audio %}
+      {% for file in post.audio %}
+      <a class="btn btn-primary" href="{{ site.url }}/episodes/{{ file.last }}">Download .{{ file.first }} ({{ file.last | file_size:'./' | string_of_size }})</a>
+      {% endfor %}
+    {% endif %}
+  <hr>
+  {{ site | flattr_button:post }}
+  <a href="https://twitter.com/share" class="twitter-share-button" data-url="{{ site.url }}{{post.url }}" data-text="{{ post.title }}">Tweet</a>
+  {% unless page.url == '/index.html' %}{% include disqus_thread.html %}{% endunless %}
+  <hr>
+</section>

data/assets/_includes/post_header.html

@@ -0,0 +1,7 @@
+<div class="page-header">
+  <h1>
+    <a class='episode_title' href='{{ site.url }}{{ post.url }}#{{ post.id | sha1:8 }}'>{{ post.title }}</a>
+    <small>{{ post.datum }}</small>
+    {% include disqus_count.html %}
+  </h1>
+</div>

data/assets/_includes/post_line.html

@@ -0,0 +1,3 @@
+<section id="{{ post.id | sha1:8 }}">
+  {% include post_header.html %}
+</section>

data/assets/_includes/sidebar.html

@@ -0,0 +1,100 @@
+<div class="page-header">
+  <h3>
+    {{ site.title }}
+    {% if site.subtitle %}<br/><small>{{ site.subtitle }}</small>{% endif %}
+  </h3>
+</div>
+
+<p class="text-center">
+  <img width="200px" src="{{ site.url }}/img/logo-360x360.png" alt="{{ site.title }} logo">
+</p>
+
+{% if site.description %}<p>{{ site.description }}</p>{% endif %}
+
+<p class="text-center">
+  <script class="podlove-subscribe-button"
+          src="https://cdn.podlove.org/subscribe-button/javascripts/app.js"
+          data-language="de"
+          data-size="medium"
+          data-json-data="podcastData"
+          data-colors="#FC6E51;green;blue"
+          data-buttonid="123abc"
+          data-hide="false">
+  </script>
+  <script>
+    window.podcastData = {
+      "title": "{{ site['title']}}",
+      "subtitle": "{{ site['subtitle']}}",
+      "description": "{{ site['description']}}",
+      "cover": "{{ site.url }}/img/logo-360x360.png",
+      "feeds": [
+      {% for feed in site['episode_feed_formats'] %}
+        {
+          "type": "audio",
+          "format": "{{ feed }}",
+          "url": "{{ site['url']}}/episodes.{{ feed }}.rss",
+          "directory-url-itunes": "{{ site['itunes_url']}}",
+          "variant": "high"
+        },
+      {% endfor %}
+      ]
+    }
+  </script>
+</p>
+
+<hr/>
+
+<h4>RSS-Feeds</h4>
+
+<ol type="i">
+  {% for feed in site['episode_feed_formats'] %}
+    <li><a href="{{ site['url']}}/episodes.{{ feed }}.rss"><i class="fa fa-rss"></i> {{ feed }}-Feed</a></li>
+  {% endfor %}
+</ol>
+
+
+<h4>Directories</h4>
+
+<ol type="i">
+  {% if site.itunes_url %}
+    <li>in Apple-<a href="{{ site.itunes_url }}"><i class="fa fa-apple"></i> Itunes</a></li>
+  {% endif %}
+  {% if site.bitlove_url %}
+    <li>as Torrents at <a href="{{ site.bitlove_url }}"><img src="https://bitlove.org/static/favicon.png"/> Bitlove</a></li>
+  {% endif %}
+  {% if site.fyyd_url %}
+    <li>at the podcast search engine <a href="{{ site.fyyd_url }}">Fyyd</a></li>
+  {% endif %}
+  {% if site.gpodder_url %}
+    <li>at <a href="{{ site.gpodder_url }}"><img src="https://gpodder.net/media/gpoddernet_64.png" height="16" /> Gpodder.net</a></li>
+  {% endif %}
+</ol>
+
+
+<h4>Credits</h4>
+
+<ul>
+  <li>Music: <a href="http://www.bensound.com/royalty-free-music">Bensound</a></li>
+</ul>
+
+<h4>License</h4>
+
+{% if site.license_url %}
+  <a rel="license" href="{{ site.license_url }}">
+    {% if site.license_image_url %}
+      <img alt="Creative Commons License" style="border-width:0" src="{{ site.license_image_url }}" />
+    {% else %}
+      {{ site.license }}
+    {% endif %}
+  </a>
+{% endif %}
+
+<hr/>
+
+{% if site.flattr_uid %}
+  <span class="pull-left">{{ site | flattr_button }}</span>
+{% endif %}
+
+{% if site.twitter_nick %}
+  <a href="https://twitter.com/{{ site.twitter_nick }}" class="twitter-follow-button" data-show-count="false">Follow @{{ site.twitter_nick }}</a>
+{% endif %}

data/assets/_includes/tweet_us.html

@@ -0,0 +1,3 @@
+<a href="https://twitter.com/share"
+   class="twitter-share-button"
+   data-text="@AuaUffCode">Tweet an @AuaUffCode</a>

data/assets/_layouts/default.html

@@ -0,0 +1,87 @@
+<!DOCTYPE html>
+<html lang="{{ site.language }}">
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+  <title>{{ site.title }} - {{ page.title | otherwise:site.subtitle }}</title>
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+  {% if site.description %}<meta name="description" content="{{ site.description | markdownify | strip_html }}">{% endif %}
+  {% if site.author %}<meta name="author" content="{{ site.author }}">{% endif %}
+
+  <link rel="alternate" type="application/atom+xml" href="{{ site.url }}/general_feed.xml" title="General Site Atom Feed (No Podcast Metadata!)" />
+  {{ site | episode_feeds_html }}
+
+  <link rel="stylesheet" type="text/css" href="{{ site.url }}/css/bootstrap.min.css">
+  <link rel="stylesheet" type="text/css" href="{{ site.url }}/css/bootflat.css">
+  <link rel="stylesheet" type="text/css" href="{{ site.url }}/css/custom_styles.css">
+  <link rel="stylesheet" type="text/css" href="{{ site.url }}/css/font-awesome.min.css">
+
+  <script type='text/javascript' src="{{ site.url }}/podlove-web-player/js/vendor/html5shiv.min.js"></script>
+  <script type='text/javascript' src="{{ site.url }}/podlove-web-player/js/vendor/jquery.min.js"></script>
+  <script type='text/javascript' src="{{ site.url }}/podlove-web-player/js/vendor/progress-polyfill.min.js"></script>
+  <script type='text/javascript' src="{{ site.url }}/podlove-web-player/js/podlove-web-moderator.js"></script>
+  <script type='text/javascript' src="{{ site.url }}/js/bootstrap.min.js"></script>
+  <script type='text/javascript' src="{{ site.url }}/js/icheck.min.js"></script>
+  <script type='text/javascript' src="{{ site.url }}/js/jquery.fs.selecter.min.js"></script>
+  <script type='text/javascript' src="{{ site.url }}/js/jquery.fs.stepper.min.js"></script>
+  <script type='text/javascript' src="{{ site.url }}/js/custom.js"></script>
+
+  {% if site.flattr_uid %}{% include flattr_loader.html %}{% endif %}
+  {% if site.disqus_shortname %}
+  <script>
+    {{ site | disqus_config }}
+  </script>
+  {% endif %}
+</head>
+
+<body>
+  <div class="container-fluid">
+    <nav class="navbar navbar-default">
+      <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">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 id="navbar" class="collapse navbar-collapse">
+            {{ site | navigation_list:page }}
+
+          <form class="navbar-form navbar-right" action="https://google.com/search" method="get" role="search">
+            <div class="form-group">
+              <input type="text" class="form-control" placeholder="search item">
+              <input type="hidden" name="q" value="site:{{ site.url | host_from_url }}" />
+            </div>
+            <button type="submit" class="btn btn-default">Search</button>
+          </form>
+        </div><!--/.nav-collapse -->
+      </div>
+    </nav>
+
+    <div class="container">
+      <div class="row ">
+        <div class="col-sm-8">
+          <div class="content">
+            {{ content }}
+          </div>
+        </div>
+        <div id="sidebar" class="col-sm-4">
+          <div class="well">
+            {% include sidebar.html %}
+          </div>
+        </div>
+      </div>
+      <div class="row" id="footer">
+        <small class="pull-right">Powered by <a href="https://github.com/pattex/octopod">Octopod</a> and <a href="http://jekyllrb.com/">Jekyll</a>.</small>
+      </div>
+    </div><!-- /.container -->
+  </div><!-- /.container -->
+
+<script>
+!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");
+</script>
+</html>

data/assets/_layouts/feed.xml

@@ -0,0 +1,66 @@
+---
+layout: null
+---
+<?xml version="1.0" encoding="UTF-8"?>
+<rss xmlns:itunes="http://www.itunes.com/dtds/podcast-1.0.dtd" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0">
+  <channel>
+    <title>{{ site.title }}</title>
+    <link>{{ site.url }}</link>
+    <atom:link href="{{ site.url }}/episodes.{{ page.format }}.rss" rel="self" type="application/rss+xml" title="{{ page.format }} Episode RSS-Feed"/>
+    {{ site | episode_feeds_rss:page.format }}
+    <description>{{ site.description | markdownify | strip_html }}</description>
+    <lastBuildDate>{{ site.time | time_to_rssschema }}</lastBuildDate>
+    <language>{{ site.language }}</language>
+
+    <itunes:summary>{{ site.description | markdownify | strip_html }}</itunes:summary>
+    <itunes:author>{{ site.author }}</itunes:author>
+    <itunes:explicit>{{ site.explicit }}</itunes:explicit>
+    <itunes:image href="{{ site.url | http_only }}/img/logo-itunes.jpg" />
+    <itunes:owner>
+      <itunes:name>{{ site.author }}</itunes:name>
+      <itunes:email>{{ site.email }}</itunes:email>
+    </itunes:owner>
+    <managingEditor>{{site.email}} ({{site.author}})</managingEditor>
+    <copyright>{{ site.license }}</copyright>
+    <itunes:subtitle>{{ site.subtitle }}</itunes:subtitle>
+    <itunes:keywords>{{ site.keywords | join:', ' }}</itunes:keywords>
+    <image>
+      <title>{{ site.title }}</title>
+      <url>{{ site.url }}/img/logo-itunes.jpg</url>
+      <link>{{ site.url }}</link>
+    </image>
+    {% for category in site.itunes_categories %}
+    <itunes:category text="{{ category }}">
+    {% endfor %}
+    </itunes:category>
+    {% for post in site.posts %}{% if post.audio[page.format] %}
+    <item>
+      <title>{{ post.title }} - {{ post.subtitle }}</title>
+      <link>{{ site.url }}{{ post.url }}</link>
+      <comments>{{ site.url }}{{ post.url }}#disqus_thread</comments>
+      <pubDate>{{ post.date | time_to_rssschema }}</pubDate>
+      {% for category in post.categories %}
+      <category><![CDATA[{{ category }}]]></category>
+      {% endfor %}
+      <guid isPermaLink="false">{{ site.url }}{{ post.url }}</guid>
+      <description><![CDATA[{{ post.content | expand_urls: site.url | cdata_escape | remove_script_and_audio }}]]></description>
+      <content:encoded><![CDATA[{{ post.content | expand_urls: site.url | cdata_escape | remove_script_and_audio }}]]></content:encoded>
+      <enclosure url="{{ site.url | http_only }}/episodes/{{ post.audio | audio:page.format }}" length="{{ post.audio | audio:page.format | file_size }}" type="{{ page.format | mime_type }}" />
+      <itunes:keywords>{{ post.tags }}</itunes:keywords>
+      <itunes:subtitle>{{ post.subtitle }}</itunes:subtitle>
+      <itunes:summary>{{ post.summary }}</itunes:summary>
+      <itunes:author>{{ post.author | otherwise:site.author }}</itunes:author>
+      <itunes:explicit>{{ post.explicit | otherwise:site.explicit }}</itunes:explicit>
+      <itunes:duration>{{ post.duration }}</itunes:duration>
+      {{ site | flattr_rss:post }}
+      {% if post.chapters %}
+      <psc:chapters version="1.1" xmlns:psc="http://podlove.org/simple-chapters">
+        {% for chapter in post.chapters %}
+        <psc:chapter start="{{ chapter | split_chapter:'start' }}" title="{{ chapter | split_chapter:'title' }}" />
+        {% endfor %}
+      </psc:chapters>
+      {% endif %}
+    </item>
+    {% endif %}{% endfor %}
+  </channel>
+</rss>

data/assets/_layouts/page.html

@@ -0,0 +1,15 @@
+---
+layout: default
+---
+<section class="active">
+  {% if page.title %}
+  <div class="page-header">
+    <h1>
+      {{ page.title }}
+      {% if page.subtitle %}<small>{{ page.subtitle }}</small>{% endif %}
+    </h1>
+  </div>
+  {% endif %}
+
+  {{ content }}
+</section>

data/assets/_layouts/player_index.html

@@ -0,0 +1,40 @@
+---
+layout: null
+---
+
+<!DOCTYPE html>
+<html lang="{{ site.language }}" prefix="og: http://ogp.me/ns#">
+
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
+  <title>{{ site.title }} - {{ page.title }}</title>
+
+  <link rel="stylesheet" type="text/css" href="{{ site.url }}/podlove-web-player/css/pwp-light-gray.css" media="screen">
+  <link rel="stylesheet" type="text/css" href="{{ site.url }}/podlove-web-player/css/vendor/progress-polyfill.css" media="screen">
+
+  <script type='text/javascript' src="{{ site.url }}/podlove-web-player/js/vendor/html5shiv.min.js"></script>
+  <script type='text/javascript' src="{{ site.url }}/podlove-web-player/js/vendor/jquery.min.js"></script>
+  <script type='text/javascript' src="{{ site.url }}/podlove-web-player/js/vendor/progress-polyfill.min.js"></script>
+
+  <meta property="og:type" content="website"/>
+  <meta property="og:site_name" content="{{ site.title }}"/>
+  <meta property="og:title" content="{{ page.title }} - {{ page.subtitle }}"/>
+  <meta property="og:url" content="{{ site.url }}{{ page.url }}"/>
+  <meta property="og:description" content="{{ site.description }}"/>
+  <meta property="og:image" content="{{ site.url }}/img/logo-360x360.png"/>
+
+  {% for feed in site['episode_feed_formats'] %}
+    <meta property="og:audio" content="{{ site.url }}/episodes/{{ page['audio'][feed] }}"/>
+    <meta property="og:audio:type" content="audio/{{ feed }}"/>
+  {% endfor %}
+</head>
+
+<body>
+  {{ page | web_player:site }}
+  <script type='text/javascript' src="{{ site.url }}/podlove-web-player/js/podlove-web-player.js"></script>
+  {{ page | web_player_script_tag:site }}
+</body>
+
+</html>