This repository was archived by the owner on Nov 9, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathusage.html
250 lines (197 loc) · 14.2 KB
/
usage.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>jekyll - octopod - Usage</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="Static Site Podcast Publishing for Geeks.
">
<meta name="author" content="Stefan Haslinger">
<link rel="alternate" type="application/atom+xml" href="https://jekyll-octopod.github.io/general_feed.xml" title="General Site Atom Feed (No Podcast Metadata!)" />
<link rel="alternate" type="application/rss+xml" title="ogg Episode RSS-Feed" href="https://jekyll-octopod.github.io/episodes.ogg.rss" />
<link rel="alternate" type="application/rss+xml" title="mp3 Episode RSS-Feed" href="https://jekyll-octopod.github.io/episodes.mp3.rss" />
<link href='/assets/css/ubuntu.css' rel='stylesheet' type='text/css'>
<link rel="stylesheet" type="text/css" href="https://jekyll-octopod.github.io/assets/css/main.css">
<link rel="stylesheet" type="text/css" href="https://jekyll-octopod.github.io/css/custom_styles.css">
<script type='text/javascript' src="https://jekyll-octopod.github.io/assets/js/jquery.min.js"></script>
<script type='text/javascript' src="https://jekyll-octopod.github.io/assets/js/bootstrap.min.js"></script>
<script type='text/javascript' src="https://jekyll-octopod.github.io/assets/js/icheck.min.js"></script>
<script type='text/javascript' src="https://jekyll-octopod.github.io/assets/js/jquery.fs.selecter.min.js"></script>
<script type='text/javascript' src="https://jekyll-octopod.github.io/assets/js/jquery.fs.stepper.min.js"></script>
<script type='text/javascript' src="https://jekyll-octopod.github.io/assets/js/custom.js"></script>
<script src='https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script>
</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="https://jekyll-octopod.github.io">jekyll - octopod</a>
</div>
<div id="navbar" class="collapse navbar-collapse">
<ul class="nav navbar-nav">
<li><a href="https://jekyll-octopod.github.io">Home</a></li>
<li><a href="https://twitter.com/jekyll_octopod"><i class="fab fa-twitter"></i> @jekyll_octopod</a>
<li><a href="https://github.com/jekyll-octopod/jekyll-octopod/issues"><i class="fab fa-github-alt"></i> Github Issues</a></li>
<li><a href="https://github.com/jekyll-octopod/jekyll-octopod"><i class="fab fa-github"></i> Github Repo</a></li>
</ul>
<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:jekyll-octopod.github.io" />
</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">
<h1 id="usage">Usage</h1>
<p>Next, update the configuration settings in the configuration file <code class="highlighter-rouge">_config.yml</code> in the application
directory. (You are already in it.)</p>
<ul>
<li>You might want to change the images and logos in the <code class="highlighter-rouge">img</code> directory</li>
<li>You might want to change the demo episode file and the Jekyll Welcome post in <code class="highlighter-rouge">_posts</code> and
<code class="highlighter-rouge">_episodes</code></li>
</ul>
<p>You can find a documentation of all the non-Octopod-specific settings on the <a href="http://jekyllrb.com/docs/configuration/">Configuration page of
the Jekyll Documentation</a>.</p>
<p>Jekyll is highly customizable, if you are into coding (or even just want to get into it), read
the <a href="https://jekyllrb.com/docs/home/">Jekyll Documentation</a>. It is very detailed and quite easy to grasp.</p>
<p>First of all, your new podcast episode needs audio data. Octopod assumes that your ready to use
audio files stay within the <code class="highlighter-rouge">episodes</code> directory in your projects root.</p>
<figure class="highlight"><pre><code class="language-shell" data-lang="shell"><span class="nv">$ </span><span class="nb">cp</span> ~/my_superduper_audio_files/ocp001.m4a episodes</code></pre></figure>
<p>In addition, jekyll-octopod assumes that the different audio files of each of your episodes are the
same content in various formats — with the same duration and everything.
If they are not, you may confuse your listeners — at least when you are using the chapters feature.</p>
<p>Next up, your episode needs some metadata. A title, some kind of a description, maybe chapters and
so on. jekyll-octopod keeps all these metadata in one single text file (Protip: these dear little
tots feel very lucky when they might live in a version control system!).
jekyll-octopod kindly helps you to generate these files with the <code class="highlighter-rouge">octopod episode</code> command. You
will get more information on the <a href="./command_line">the command line tool</a> later.</p>
<p>The following command</p>
<figure class="highlight"><pre><code class="language-shell" data-lang="shell"><span class="nv">$ </span>octopod episode <span class="nt">--title</span> <span class="s2">"Why I <3 Octopod"</span></code></pre></figure>
<p>will generate you a template called <strong>YYYY-MM-DD-why-i-_3-octopod.md</strong> (YYYY-MM-DD represents the current date) in your <code class="highlighter-rouge">_posts</code> subdirectory. When you open it in your text editor you’ll see something like this:</p>
<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="nn">---</span>
<span class="na">title</span><span class="pi">:</span> <span class="s">Why I <3 Octopod</span>
<span class="na">subtitle</span><span class="pi">:</span> <span class="s">A Subtle Subtitle</span>
<span class="na">image</span><span class="pi">:</span> <span class="s2">"</span><span class="s">episode-cover0.jpg"</span> <span class="c1"># This can be used to provide episode-specific images</span>
<span class="na">datum</span><span class="pi">:</span> <span class="s">March 22nd </span><span class="m">2016</span> <span class="c1"># this is no longer necessary, but in de or en installations, it is still respected</span>
<span class="na">layout</span><span class="pi">:</span> <span class="s">post</span>
<span class="na">author</span><span class="pi">:</span> <span class="s">Uncle Octopod</span>
<span class="na">explicit</span><span class="pi">:</span> <span class="s1">'</span><span class="s">no'</span>
<span class="na">duration</span><span class="pi">:</span> <span class="s2">"</span><span class="s">0:03:13"</span>
<span class="na">audio</span><span class="pi">:</span>
<span class="na">m4a</span><span class="pi">:</span> <span class="s">name.m4a</span>
<span class="na">mp3</span><span class="pi">:</span> <span class="s">name.mp3</span>
<span class="na">ogg</span><span class="pi">:</span> <span class="s">name.ogg</span>
<span class="na">chapters</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s1">'</span><span class="s">00:00:00.000</span><span class="nv"> </span><span class="s">Intro.'</span>
<span class="pi">-</span> <span class="s1">'</span><span class="s">00:00:30.000</span><span class="nv"> </span><span class="s">Outro.'</span>
<span class="na">posts-dir</span><span class="pi">:</span> <span class="s2">"</span><span class="s">/path/to/post/dir"</span> <span class="c1"># default: '_posts'</span>
<span class="nn">---</span>
<span class="c1">## </span>
<span class="pi">{{</span> <span class="nv">podigee_player page</span> <span class="pi">}}</span>
<span class="c1">## Shownotes and Links</span>
<span class="err">*</span> <span class="s">Note</span></code></pre></figure>
<p>The part between the “—” and the “—” is the <a href="http://jekyllrb.com/docs/frontmatter/">YAML front matter</a>.
This is where all the metadata is stored. Below the YAML frontmatter is the area (body) where you
can write down your post’s content (like the show notes and stuff).
This strange looking <code class="highlighter-rouge">{{ podigee_player page }}</code> thingy is the
<a href="./liquid-filters">Liquid filter</a>, which represents the iframe where the web player will be included
later.</p>
<p>When all this work is done you are ready to take a first look.
The following command generates your site and starts a local webserver for a preview. You can check
your new podcasting website by opening <a href="http://localhost:4000">http://localhost:4000</a>.</p>
<figure class="highlight"><pre><code class="language-shell" data-lang="shell"><span class="nv">$ </span>octopod <span class="nt">--url</span> <span class="s2">"http://localhost:4000"</span> <span class="nt">--server</span></code></pre></figure>
<p>Since <code class="highlighter-rouge">localhost:4000</code> is the default, a shorter command with the same result is:</p>
<figure class="highlight"><pre><code class="language-shell" data-lang="shell"><span class="nv">$ </span>octopod s[erve]</code></pre></figure>
<p>If everything looks good, you can generate the site with the proper url from your configuration.
<em>Warning</em>: Don’t upload the <code class="highlighter-rouge">_site</code> subdirectory after serving it locally, as all links will assume
running on <code class="highlighter-rouge">localhost</code> and this will cause issues!</p>
<p>To build your site use</p>
<figure class="highlight"><pre><code class="language-shell" data-lang="shell"><span class="nv">$ </span>octopod b[uild]</code></pre></figure>
<p>And deploy it to your server:</p>
<figure class="highlight"><pre><code class="language-shell" data-lang="shell"><span class="nv">$ </span>octopod deploy</code></pre></figure>
<p><em>Warning</em>: The Rsync settings in your <code class="highlighter-rouge">_config.yml</code> are mandatory for this last step.
If you don’t wish to use rsync, uploading the website from the <code class="highlighter-rouge">_site</code> subdirectory via FTP or
whichever tool you prefer works just fine.</p>
<h2 id="jekyll-admin">Jekyll Admin</h2>
<p>We have also included Jekyll Admin, so you can create new posts and update existing ones using a
web interface at <a href="http://localhost:4000/admin">http://localhost:4000/admin</a>
You could even change the config in the web interface.</p>
<p>To enable Jekyll admin uncomment the lines</p>
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code># plugins:
# - jekyll-admin
</code></pre></div></div>
<p>in your project’s <code class="highlighter-rouge">_config.yml</code> file.</p>
<p>See the <a href="https://jekyll.github.io/jekyll-admin/">documentation of Jekyll Admin</a> for details.
Unfortunately Jekyll Admin kills Jekyll’s auto regeneration feature. So if you prefer auto regeneration
over the web based admin, disable the gem all together by removing it from the <code class="highlighter-rouge">plugin</code> array in
the <code class="highlighter-rouge">_config.yml</code> file or commenting it in <code class="highlighter-rouge">_config.yml</code>.</p>
<p><em>Continue with <a href="/command_line">The command line tool</a></em>.</p>
</div>
</div>
<div id="sidebar" class="col-sm-4">
<div class="well">
<div class="page-header">
<h3>
jekyll - octopod
<br/><small>Static Site Podcast Publishing for Geeks</small>
</h3>
</div>
<p class="text-center">
<img width="200px" src="https://jekyll-octopod.github.io/img/logo-360x360.png" alt="jekyll - octopod logo">
</p>
<p>Static Site Podcast Publishing for Geeks.</p>
<hr/>
<h3> Documentation - Topics</h3>
<ol>
<li><a href="https://jekyll-octopod.github.io/prerequisites">Prerequisites</a></li>
<li><a href="https://jekyll-octopod.github.io/installation">Installation</a></li>
<li><a href="https://jekyll-octopod.github.io/configuration">Configuration</a></li>
<li><a href="https://jekyll-octopod.github.io/demo">Demo</a></li>
<li class="active"><a class="active" href="https://jekyll-octopod.github.io/usage">Usage</a></li>
<li><a href="https://jekyll-octopod.github.io/command_line">Command Line Tool</a></li>
<li><a href="https://jekyll-octopod.github.io/theming">Theming</a></li>
<li><a href="https://jekyll-octopod.github.io/liquid_filters">Liquid Filters</a></li>
<li><a href="https://jekyll-octopod.github.io/post_structure">Post structure</a></li>
<li><a href="https://jekyll-octopod.github.io/contributions">Contributions</a></li>
<li><a href="https://jekyll-octopod.github.io/credits">Credits</a></li>
<li><a href="https://jekyll-octopod.github.io/license">License</a></li>
<li><a href="https://jekyll-octopod.github.io/conduct">Code of Conduct</a></li>
</ol>
<h3> Source Code </h3>
<ul>
<li>
<a href="https://github.com/jekyll-octopod/jekyll-octopod">
<i class="fab fa-github"></i> Github
</a>
</li>
</ul>
<h3>Social Media</h3>
For us on Twitter for News!
<br/>
<a href="https://twitter.com/jekyll_octopod" class="twitter-follow-button" data-show-count="false">Follow @jekyll_octopod</a>
</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>