.TH JEKYLL "1" "January 2020" "Jekyll 3.8" "User Commands"

.SH NAME
jekyll \- blog-aware, static site generator

.SH USAGE
.BI "jekyll command [" options... "]"

.SH COMMANDS
.TP
.B docs
It requires the \fBjekyll-docs\fR plugin to be installed.
.TP
.B import
This command allows one to import blog content from various resources as
markdown files into the Jekyll \fI\./_post/\fR and \fI\./_drafts/\fR structure. It
requires the \fBjekyll-import\fR plugin to be installed.
.TP
.BI "new [" PATH "]"
Creates a new Jekyll site scaffold in \fIPATH\fR.
.TP
.BI "b, build
Build the site from its sources and put the results into the destination
directory.
.TP
.BI "s, serve, server
Serve the site locally.
.TP
.B doctor, hyde
Search site and print specific any deprecation or configuration issues.
.TP
.B clean
Remove the destination directory.
.TP
.B new-theme
Creates a new Jekyll theme scaffold
.TP
.BI "help [" COMMAND "]"
Show the help message, optionally for a given subcommand.
.PP
Plugins like \fBjekyll-compose\fR can provide more commands then documented
here.

.SH OPTIONS
There are some general flags to control Jekyll's behavior:
.TP
.BI "\-s, \-\-source [" DIR "]"
Source directory (defaults to \fI./\fR). This can also be set
in \fI_config.yml\fR via the \fBsource:\fR option.
.TP
.BI "\-d, \-\-destination [" DIR "]"
Destination directory (defaults to \fI./_site\fR). This can also be set
in \fI_config.yml\fR via the \fBdestination:\fR option.
.TP
.BI "\-p, \-\-plugins " PLUGINS_DIR1 "[," PLUGINS_DIR2 "[," ... "]]"
Plugins directory (defaults to \fI./_plugins\fR).
.TP
.B \-\-safe
Safe mode (defaults to \fIfalse\fR). This disables custom plugins, and ignores
links. This can also be set in \fI_config.yml\fR via the \fBsafe:\fR option.
.TP
.BI "\-\-layouts " DIR
Layouts directory (defaults to \fI./_layouts\fR).
.TP
.B \-\-profile
Generate a Liquid rendering profile.
.TP
.B \-h, \-\-help
Show the help output.
.TP
.B \-v, \-\-version
Print the name and version
.TP
.B \-t, \-\-trace
Show the full backtrace when an error occurs.

.SS NEW OPTIONS
The following options control a \fBnew\fR site's creation.
.TP
.B \-\-blank
Create just the site scaffolding but with empty files.
.TP
.B \-\-force
Force creation of the site even if the default or given destination \fIPATH\fR
already exists.
.TP
.B \-\-skip-bundle
Skip '\fBbundle install\fR' which is run by default.

.SS BUILD OPTIONS
The following options control the \fBbuild\fR command.
.TP
.BI "\-\-config " CONFIG_FILE "[," CONFIG_FILE2 ",...]"
Use one or more (custom) configuration files instead of or together
with \fI_config.yml\fR. Settings specified in later files override
earlier definitions.
.TP
.BI "\-b, \-\-baseurl " URL
Serve the website from the given base \fIURL\fR.
.TP
.B \-I, \-\-incremental
Enable incremental rebuilds. Only generate documents and pages that were
updated since the previous build. The file \fI.jekyll-metadata\fR keeps track
of both file modification times and inter-document dependencies.
.TP
.B \-w, \-\-[no\-]watch
Watch for changes and rebuild the changed sites from source. This 
.TP
.BI "\-\-limit_posts " MAX_POSTS
Limit the number of posts to parse and publish.
.TP
.B \-\-future
Publish posts or collection documents with a future date.
.TP
.B \-D, \-\-drafts
Process and render posts in the _drafts folder (defaults to \fIno\fR).
.TP
.B \-\-unpublished
Render posts that are marked as unpublished (defaults to \fIno\fR).
.TP
.B \-\-force_polling
Force watch to use polling.
.TP
.B \-\-lsi
Use a Latent Semantic Indexer (LSI) like \fIclassifier-reborn\fR for an
improved related posts feature.
.TP
.B \-\-strict_front_matter
Fail the build if errors are present in the front matter.
.TP
.B \-q, \-\-quiet
Silence output.
.TP
.B \-V, \-\-verbose
Print verbose output.

.SS SERVE OPTIONS
Serving a site all options to the \fBbuild\fR command are supported together
with these additional options.
.TP
.BI "\-H, \-\-host [" HOST "]"
Local server hostname to listen to. The default is \fI127.0.0.1\fR
or \fRlocalhost\fR.
.TP
.BI "\-P, \-\-port [" PORT "]"
Local server port to bind to. The default is \fI4000\fR.
.TP
.BI "\-\-ssl\-cert [" CERT "]"
X.509 (SSL) certificate.
.TP
.BI "\-\-ssl\-key [" KEY "]"
X.509 (SSL) private key.
.TP
.B \-B, \-\-detach
Run the server in the background.
.TP
.B \-\-skip\-initial\-build
Skip initial site build which occurs before the server is started.
.TP
.B \-o, \-\-open\-url
Launch the site in a browser.
.TP
.B \-\-show\-dir\-listing
Show a directory listing instead of loading the index file.
.TP
.B \-l, \-\-livereload
Use LiveReload to automatically refresh the browser.
.TP
.BI "\-\-livereload\-ignore ignore " GLOB1 "[," GLOB2 "[,...]]"
Files for LiveReload to ignore. The values must be quoted so the shell won't
expand them.
.TP
.BI "\-\-livereload\-min\-delay [" SECONDS "]"
Minimum reload delay.
.TP
.BI "\-\-livereload\-max\-delay [" SECONDS "]"
Maximum reload delay.
.TP
.BI "\-\-livereload-port [" PORT "]"
Port for LiveReload to listen on.

.SS NEW THEME OPTIONS
The following options control the \fBnew-theme\fR command.
.TP
.B \-c, \-\-code\-of\-conduct
Include a Code of Conduct (defaults to \fIfalse\fR).

.SH FILES
.TP
.I _config.yml
The main configuration is done by default in the file \fI_config.yml\fR. This
file can control both Jekyll's behavior (see \fBOPTIONS\fR) and site/theme
configuration variables. If the configuration shall be split or a non-default
file shall be used one can use the \fB\-\-config\fR switch to define all
configuration files.
.PP
See <\%https://jekyllrb.com/docs/configuration/options/\%>
and <\%https://jekyllrb.com/docs/configuration/default/\%>.

.SH ENVIRONMENT
.TP
.B JEKYLL_ENV
This environment variable defaults to \fIdevelopment\fR and can be checked
during build via conditional statements to influence the output for example.
It usually only affects the \fBbuild\fR and \fBserve\fR commands. The other
well known value is \fIproduction\fR, but really any value can be assigned.
.PP
See <\%https://jekyllrb.com/docs/configuration/environments/\%>.

.SH "SEE ALSO"
There is extensive documentation at <\%https://jekyllrb.com/docs/\%>.

.SH AUTHOR
This manual page was originally written by
\fBYouhei SASAKI\fP <\%uwabami@gfd-dennou\.org\%>, for the Debian GNU/Linux
system (but may be used by others). It was later updated by
\fBDaniel Leidert\fP <\%dleidert@debian\.org\%>