jekyll-octopod 0.3.0 → 0.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +43 -60
- data/bin/octopod +22 -10
- data/lib/jekyll/octopod/version.rb +1 -1
- metadata +3 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 38dd403316e5bbd5e7f7832da809f30a39f31e9e
|
|
4
|
+
data.tar.gz: 3443307d1ebff4d848449609d76c0c9bd60ed556
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 736b43cbd02a3a1db6b2c476c8f3291e7ad156a8eb7ed02372fc6985629ccb4abeda2b62ebb14c5e60b1616e967f4274acd9dcb4f3f947a07d0880744813a9d4
|
|
7
|
+
data.tar.gz: 8cc2e80bde2b454b5aeef7e5630ce71e25b73cb9bceb9ad772a932195e77707ee3769fd2c1e54c5bd17e9826a04eb61ab81b5967fc4388c9c26e9bada20b863b
|
data/README.md
CHANGED
|
@@ -1,84 +1,67 @@
|
|
|
1
1
|
# Jekyll - Octopod
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<img align="right" src="assets/img/logo.jpg" alt="logo">
|
|
4
|
+
A podcast publishing extension for the static site generator [Jekyll](https://jekyllrb.com/)
|
|
4
5
|
|
|
5
|
-
|
|
6
|
+
## tl;dr
|
|
6
7
|
|
|
7
|
-
|
|
8
|
+
You generate a static web site for your podcast on your own computer, test drive it and sync it to your web space.
|
|
8
9
|
|
|
9
|
-
|
|
10
|
+
So no Wordpress, PHP, Ruby other scripting language, database management system or any other dynamic component is needed on your server.
|
|
11
|
+
Thich increases security immensely.
|
|
10
12
|
|
|
11
|
-
|
|
12
|
-
the [Rails Girls Website](http://guides.railsgirls.com/install). You can stop
|
|
13
|
-
right before installing Rails, because we do not depend on Ruby on Rails here.
|
|
13
|
+
## Tell me more!
|
|
14
14
|
|
|
15
|
-
|
|
16
|
-
```
|
|
17
|
-
$ ruby -v
|
|
18
|
-
$ gem -v
|
|
19
|
-
```
|
|
20
|
-
at the command prompt. Both commands should return version greater or equal 2.0 .
|
|
15
|
+
If you want to take a look: See (and listen to) Stefan's podcast [Aua-Uff-Code!](https://aua-uff-co.de).
|
|
21
16
|
|
|
22
|
-
|
|
17
|
+
The page, you will get, when you follow the installation instructions later, looks like this:
|
|
23
18
|
|
|
24
|
-
|
|
25
|
-
$ gem install jekyll
|
|
26
|
-
$ jekyll new name-of-my-podcast
|
|
27
|
-
$ cd name-of-my-podcast
|
|
28
|
-
```
|
|
19
|
+
|
|
29
20
|
|
|
30
|
-
|
|
21
|
+
Technically speaking, jekyll-octopod is a Jekyll plugin and a Ruby Gem. It
|
|
22
|
+
contains of scripts, templates, helpers and extensions to publish your
|
|
23
|
+
podcasts the cool text file lover's way.
|
|
31
24
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
```
|
|
25
|
+
If you are not afraid of the command line of your computer and text files are the
|
|
26
|
+
stuff to heat up your geeky little heart, jekyll-octopod may be worth a trial
|
|
27
|
+
to publish your podcasts.
|
|
36
28
|
|
|
37
|
-
|
|
29
|
+
The underlying assumptions of Octojekyll-octopodpod are that static content
|
|
30
|
+
should be delivered statically and text files are the perfect way to handle
|
|
31
|
+
podcast metadata. So jekyll-octopod makes it easy to generate and deploy a
|
|
32
|
+
website and feeds for your podcast out of one textfile and at least one audio
|
|
33
|
+
file per episode.
|
|
38
34
|
|
|
39
|
-
```
|
|
40
|
-
$ bundle install
|
|
41
|
-
$ octopod setup
|
|
42
|
-
```
|
|
43
35
|
|
|
44
|
-
|
|
45
|
-
application directory.
|
|
36
|
+
## Features
|
|
46
37
|
|
|
47
|
-
|
|
48
|
-
|
|
38
|
+
Jekyll-Octopod brings innately:
|
|
39
|
+
* iTunes ready episode feeds for different file formats (e.g. mp3, ogg, m4a)
|
|
40
|
+
* a ready to use [Bootflat](http://bootflat.github.io/) and [Twitter Bootstrap](http://twitter.github.com/bootstrap/) based, responsible (i.e. mobile friendly) layout modifiable to your heart's desire.
|
|
41
|
+
* [Flattr](https://flattr.com/) support on the website and in the episode feed
|
|
42
|
+
* [Twitter](https://twitter.com) integration on the website
|
|
43
|
+
* comments via [Disqus](http://disqus.com/)
|
|
44
|
+
* [Podlove Web Player](http://podlove.org/podlove-web-player/) in it's current version 3.0
|
|
45
|
+
* Static player pages that are embeddable in iframes at your other or affiliates' sites
|
|
46
|
+
* [Podlove Alternate Feeds](http://podlove.org/alternate-feeds/)
|
|
47
|
+
* [Podlove Simple Chapters](http://podlove.org/simple-chapters/)
|
|
48
|
+
* [Podlove Subscribe Button](http://podlove.org/podlove-subscribe-button/) for easy podcast subscription on any operating system, including mobile phones.
|
|
49
|
+
* https compatibility
|
|
50
|
+
* Google search integration
|
|
51
|
+
* easy creation of show notes
|
|
49
52
|
|
|
53
|
+
**Is this production ready?**
|
|
50
54
|
|
|
51
|
-
|
|
55
|
+
We use it in production, so we believe it is.
|
|
56
|
+
But it is very likely, that it still contains bugs. And there is no guarantee that behavior will change with the next update :-).
|
|
52
57
|
|
|
58
|
+
Hopefully you are brave enough to play with this cute little toy anyway.
|
|
53
59
|
|
|
54
|
-
## Contributions
|
|
55
60
|
|
|
56
|
-
|
|
61
|
+
## Documentation
|
|
62
|
+
|
|
63
|
+
Detailed documentation is provided in the [Wiki](https://github.com/informatom/jekyll-octopod/wiki)
|
|
57
64
|
|
|
58
65
|
## Maintainer
|
|
59
66
|
|
|
60
67
|
Stefan Haslinger <mailto:stefan.haslinger@informatom.com>
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
## Credits
|
|
64
|
-
|
|
65
|
-
This Gem is sitting on the shoulder of giants, lots of the code was not written
|
|
66
|
-
by me and/or depends on other code.
|
|
67
|
-
|
|
68
|
-
Especially to be mentioned: Arne Eilermann eilermann@lavabit.com who started and
|
|
69
|
-
created Octopod https://github.com/pattex/octopod
|
|
70
|
-
|
|
71
|
-
## License
|
|
72
|
-
|
|
73
|
-
[Licensend under the MIT-License](LICENSE)
|
|
74
|
-
|
|
75
|
-
The following assets from seperate projects are packaged in this repo:
|
|
76
|
-
* The cute Octopod Logo is by Thekla "TeMeL" Löhr, http://www.temel-art.de/, CC BY 3.0 Germany License
|
|
77
|
-
* Podlove Webplayer, version 3.0.0-beta.3, http://podlove.org/podlove-web-player/, BSD 2-Clause License
|
|
78
|
-
* Bootflat, version 2.0.4, http://bootflat.github.io/, MIT License
|
|
79
|
-
* Bootstrap, version 3.3.0 http://getbootstrap.com/, MIT License
|
|
80
|
-
* Glyphicons, http://glyphicons.com/, are licensed via Bootstrap
|
|
81
|
-
* Font Awesome, version 4.5.0, http://fontawesome.io/, Font: SIL OFL 1.1, CSS: MIT License
|
|
82
|
-
* iCheck, version 1.0.1, http://git.io/arlzeA, MIT License
|
|
83
|
-
* JQuery, version 1.11.3., https://jquery.com/, MIT License
|
|
84
|
-
* Demo Audio from Bensound, http://www.bensound.com/royalty-free-music, CC BY-ND 3.0 License
|
data/bin/octopod
CHANGED
|
@@ -12,11 +12,12 @@ Octopod - podcast publishing for geeks
|
|
|
12
12
|
|
|
13
13
|
Basic Command Line Usage:
|
|
14
14
|
Standard Jekyll commands:
|
|
15
|
-
octopod
|
|
16
|
-
octopod <path to write generated site>
|
|
17
|
-
octopod <path to source> <path to write generated site>
|
|
18
|
-
octopod import <importer name> <options>
|
|
19
|
-
octopod setup
|
|
15
|
+
octopod b[uild] # . -> ./_site
|
|
16
|
+
octopod build <path to write generated site> # . -> <path>
|
|
17
|
+
octopod build <path to source> <path to write generated site> # <path> -> <path>
|
|
18
|
+
octopod import <importer name> <options> # imports posts using named import script
|
|
19
|
+
octopod setup # Setup blog to become podcast-aware, copy assets and default config
|
|
20
|
+
octopod s[erver] # Starts the server
|
|
20
21
|
|
|
21
22
|
Additional Octopod commands:
|
|
22
23
|
octopod episode # adds a template for a new episode
|
|
@@ -110,14 +111,21 @@ if ARGV.size > 0 && (ARGV[0] == 'episode' || ARGV[0] == 'deploy' || ARGV[0] == '
|
|
|
110
111
|
|
|
111
112
|
when 'episode'
|
|
112
113
|
post_header = {
|
|
113
|
-
'title' =>
|
|
114
|
+
'title' => 'A Title',
|
|
115
|
+
'subtitle' => "A Subtle Subtitle",
|
|
116
|
+
'datum' => 'May 22nd, 2016',
|
|
114
117
|
'layout' => 'post',
|
|
115
118
|
'author' => options['author'],
|
|
116
119
|
'explicit' => options['explicit'] || 'no',
|
|
120
|
+
'duration' => "0:01:00",
|
|
117
121
|
'audio' => {
|
|
118
122
|
'm4a' => 'name.m4a',
|
|
119
123
|
'mp3' => 'name.mp3',
|
|
120
|
-
'
|
|
124
|
+
'ogg' => 'name.ogg'},
|
|
125
|
+
'chapters' => [
|
|
126
|
+
'00:00:00.000 Intro.',
|
|
127
|
+
'00:00:30.000 Outro.'
|
|
128
|
+
]
|
|
121
129
|
}
|
|
122
130
|
|
|
123
131
|
opts = OptionParser.new do |opts|
|
|
@@ -185,9 +193,9 @@ if ARGV.size > 0 && (ARGV[0] == 'episode' || ARGV[0] == 'deploy' || ARGV[0] == '
|
|
|
185
193
|
open(filename, 'w') do |post|
|
|
186
194
|
post.puts post_header.to_yaml
|
|
187
195
|
post.puts '---'
|
|
188
|
-
post.puts "
|
|
189
|
-
post.puts "{{ page |
|
|
190
|
-
post.puts "## Shownotes\n* Note"
|
|
196
|
+
post.puts "## {{ page.subtitle }}\n\n"
|
|
197
|
+
post.puts "{{ page | web_player_moderator:site }}\n\n"
|
|
198
|
+
post.puts "## Shownotes and Links\n\n* Note"
|
|
191
199
|
end
|
|
192
200
|
|
|
193
201
|
puts "Created new episode: #{filename}" if File.exists?(filename)
|
|
@@ -242,6 +250,10 @@ if ARGV.size > 0 && (ARGV[0] == 'episode' || ARGV[0] == 'deploy' || ARGV[0] == '
|
|
|
242
250
|
Dir.glob(GEM_DIR + "/assets/**/.*").each do |file|
|
|
243
251
|
copy_file_or_create_dir(file)
|
|
244
252
|
end
|
|
253
|
+
|
|
254
|
+
if write_file?(PWD + "/_config.yaml")
|
|
255
|
+
FileUtils.cp(GEM_DIR + "/assets/_config.yml.sample", PWD + "/_config.yml", {verbose: true})
|
|
256
|
+
end
|
|
245
257
|
puts "===== ... done ===== ", ""
|
|
246
258
|
end
|
|
247
259
|
else
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jekyll-octopod
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.4.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Arne Eilermann
|
|
@@ -9,7 +9,7 @@ authors:
|
|
|
9
9
|
autorequire:
|
|
10
10
|
bindir: bin
|
|
11
11
|
cert_chain: []
|
|
12
|
-
date: 2016-05-
|
|
12
|
+
date: 2016-05-29 00:00:00.000000000 Z
|
|
13
13
|
dependencies:
|
|
14
14
|
- !ruby/object:Gem::Dependency
|
|
15
15
|
name: jekyll
|
|
@@ -73,9 +73,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
73
73
|
version: '0'
|
|
74
74
|
requirements: []
|
|
75
75
|
rubyforge_project: jekyll-
|
|
76
|
-
rubygems_version: 2.
|
|
76
|
+
rubygems_version: 2.4.8
|
|
77
77
|
signing_key:
|
|
78
78
|
specification_version: 4
|
|
79
79
|
summary: Podcasting Publishing Extension for Jekyll
|
|
80
80
|
test_files: []
|
|
81
|
-
has_rdoc:
|