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 pathcommand_line.html
208 lines (160 loc) · 9.74 KB
/
command_line.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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>jekyll - octopod - Command Line Tool</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="command-line-tool">Command Line Tool</h1>
<p>The octopod-jekyll command line commands are:</p>
<figure class="highlight"><pre><code class="language-shell" data-lang="shell"><span class="nv">$ </span>octopod b[uild]
<span class="c"># builds from current path . to ./_site</span>
<span class="nv">$ </span>octopod build <path/to/target>
<span class="c"># compiles and builds the site from the current path . to path/to/target</span>
<span class="nv">$ </span>octopod build <path/to/source> <path/to/target>
<span class="c"># compiles from source_path to path/to/target</span>
<span class="nv">$ </span>octopod import <importer name> <options>
<span class="c"># imports posts using named import script</span>
<span class="nv">$ </span>octopod setup
<span class="c"># Sets up Jekyll site to become podcast-aware, copies assets and default config.</span>
<span class="c"># Asks for confirmation on file overwrite.</span>
<span class="nv">$ </span>octopod episode
<span class="c"># adds a post for a new episode</span>
<span class="nv">$ </span>octopod deploy
<span class="c"># deploys your site via rsync</span>
<span class="nv">$ </span>octopod <<span class="nb">command</span><span class="o">></span> <span class="nt">--help</span>
<span class="c"># for more information on a specific command.</span>
<span class="nv">$ </span>octopod s[erver]
<span class="c"># Starts the server</span></code></pre></figure>
<p>Configuration is read from ‘<source />/_config.yml’ but can be overridden.
Available options are documented in <code class="highlighter-rouge">_config.yml</code>.
In case, you deleted some of the options, a full reference can be found in <code class="highlighter-rouge">_config.yml.sample</code>.</p>
<p>For <code class="highlighter-rouge">octopod episode</code>, the following options are available to override defaults:</p>
<figure class="highlight"><pre><code class="language-shell" data-lang="shell"><span class="nt">-a</span>, <span class="nt">--author</span> <span class="o">[</span>AUTHOR]
<span class="nt">-c</span>, <span class="nt">--chapters</span> <span class="o">[</span>CHAPTER1, CHAPTER2...]
<span class="c"># Chapters have the format "HH:MM:SS.sss Title"</span>
<span class="nt">-d</span>, <span class="nt">--duration</span> <span class="o">[</span>DURATION]
<span class="c"># "HH:MM:SS.sss"</span>
<span class="nt">-e</span>, <span class="nt">--explicit</span> <span class="o">[</span><span class="nb">yes</span>/no]
<span class="nt">--episode-cover</span> <span class="o">[</span>PATH]
<span class="c"># Path to an episode-specific image</span>
<span class="nt">-l</span>, <span class="nt">--layout</span> <span class="o">[</span>LAYOUT]
<span class="c"># Defaults to 'post', should never need to be changed</span>
<span class="nt">-p</span>, <span class="nt">--posts_dir</span> <span class="o">[</span>PATH]
<span class="c"># Defaults to '_posts'</span>
<span class="nt">-s</span>, <span class="nt">--subtitle</span> <span class="o">[</span>TEXT]
<span class="nt">--summary</span> <span class="o">[</span>TEXT]
<span class="nt">--tags</span> <span class="o">[</span>TAG1, TAG2, ...]
<span class="nt">-t</span>, <span class="nt">--title</span> <span class="o">[</span>TEXT]</code></pre></figure>
<p>All derived Jekyll command line tasks can be found in Jekyll’s
<a href="http://jekyllrb.com/docs/usage/">Usage Documentation</a>, from which the octopod
command inherits most of its functionality.</p>
<p>If there is an error when building the site, using the <code class="highlighter-rouge">-t</code> option prints
out the full stack trace, which can be helpful in debugging and improves bug reports.</p>
<p><em>Continue reading with <a href="/liquid_filters">Liquid filters</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 class="active"><a class="active" 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>