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 pathpost_structure.html
205 lines (165 loc) · 11.8 KB
/
post_structure.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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>jekyll - octopod - Post structure</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="post-structure">Post structure</h1>
<p>The post template can be found in <code class="highlighter-rouge">/_includes/post.html</code>. It renders the posts from the <code class="highlighter-rouge">/_post</code> directory.
Each post has to have a certain structure which consists of the YAML front matter and of the body part.</p>
<h2 id="the-yaml-front-matter">The YAML front matter</h2>
<p>jekyll-octopod’s YAML front matter is an extension of <a href="https://github.com/mojombo/jekyll/wiki/YAML-Front-Matter">Jekyll’s YAML front matter</a>.</p>
<p>The attributes that can be set here are best described with the following example; they are quite self-explanatory:</p>
<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="na">title</span><span class="pi">:</span> <span class="s">Episode </span><span class="m">0</span>
<span class="na">subtitle</span><span class="pi">:</span> <span class="s">Getting Started Is Never Easy</span>
<span class="na">summary</span><span class="pi">:</span> <span class="s">Otherwise the summary is the first paragraph of the show notes</span>
<span class="c1">### datum: this is no longer necessary, but in de or en installations, it is still respected</span>
<span class="na">datum</span><span class="pi">:</span> <span class="s">March 22nd </span><span class="m">2016</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">Arne and Stefan</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="s1">'</span><span class="s">0:03:13'</span> <span class="c1"># 'hh:mm:ss'</span>
<span class="na">audio</span><span class="pi">:</span>
<span class="na">mp3</span><span class="pi">:</span> <span class="s">episode0.mp3</span>
<span class="na">ogg</span><span class="pi">:</span> <span class="s">episode0.ogg</span>
<span class="na">m4a</span><span class="pi">:</span> <span class="s">episode0.m4a</span>
<span class="c1">### File size is only necessary, if assets are not hosted in the episodes directory.</span>
<span class="na">filesize</span><span class="pi">:</span>
<span class="na">mp3</span><span class="pi">:</span> <span class="m">123456</span>
<span class="na">ogg</span><span class="pi">:</span> <span class="m">234567</span>
<span class="na">m4a</span><span class="pi">:</span> <span class="m">345678</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">...</span><span class="nv"> </span><span class="s">Shoubidoubidoo</span><span class="nv"> </span><span class="s">...'</span>
<span class="pi">-</span> <span class="s1">'</span><span class="s">00:02:45.000</span><span class="nv"> </span><span class="s">Outro.'</span>
<span class="na">tags</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s1">'</span><span class="s">a</span><span class="nv"> </span><span class="s">tag'</span>
<span class="pi">-</span> <span class="s1">'</span><span class="s">another</span><span class="nv"> </span><span class="s">tag'</span>
<span class="na">contributors</span><span class="pi">:</span>
<span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">John</span><span class="nv"> </span><span class="s">Doe'</span>
<span class="na">uri</span><span class="pi">:</span> <span class="s1">'</span><span class="s">http://doe.com/john'</span>
<span class="na">email</span><span class="pi">:</span> <span class="s1">'</span><span class="s">[email protected]'</span>
<span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Jane</span><span class="nv"> </span><span class="s">Doe'</span>
<span class="na">uri</span><span class="pi">:</span> <span class="s1">'</span><span class="s">http://doe.com/jane'</span>
<span class="na">email</span><span class="pi">:</span> <span class="s1">'</span><span class="s">[email protected]'</span>
<span class="c1">### image: only filename to be provided here, image should be put in /img directory; optional</span>
<span class="na">image</span><span class="pi">:</span> <span class="s">episode17.png</span>
<span class="na">image_title</span><span class="pi">:</span> <span class="s">My Image Title for Episode 17</span></code></pre></figure>
<h2 id="the-body">The body</h2>
<p>The body part can contain arbitrary markdown content.</p>
<p>At minimum a short text, the web player (embedded in an iframe) and some links are recommended. For example:</p>
<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="s">Getting started is hard.</span>
<span class="pi">{{</span> <span class="nv">podigee_player page</span> <span class="pi">}}</span>
<span class="c1">## Show Notes und Links</span>
<span class="err">*</span> <span class="na">Link lists are easily created</span><span class="pi">:</span> <span class="pi">[</span><span class="nv">Aua-uff-Code! Podcast</span><span class="pi">]</span><span class="s">(https://aua-uff-co.de)</span>
<span class="err">*</span> <span class="s">another link to [Jekyll](https://jekyllrb.com/)</span></code></pre></figure>
<p>Audio and script tags get filtered out of the body for feed creation, so that they do not disturb in podcatchers rendering the shown notes.</p>
<p>You can create scientific formulas using the full MathJax syntax http://www.mathjax.org/</p>
<p><em>Continue reading with <a href="/contributions">Contributions</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><a 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 class="active"><a class="active" 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>