.\" Man page generated from reStructuredText.
.
.TH NIKOLA 1 "" "Nikola v7.6.4" "User Commands"
.SH NAME
Nikola \- A Static Site and Blog Generator
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
Create an empty site (with a setup wizard):
.INDENT 0.0
.INDENT 3.5
\fBnikola init mysite\fP
.UNINDENT
.UNINDENT
.sp
(You can create a site with demo files in it with \fBnikola init \-\-demo mysite\fP)
.sp
Create a post (inside the \fBmysite\fP directory):
.INDENT 0.0
.INDENT 3.5
\fBnikola new_post\fP
.UNINDENT
.UNINDENT
.sp
Build the site:
.INDENT 0.0
.INDENT 3.5
\fBnikola build\fP
.UNINDENT
.UNINDENT
.sp
Start the test server and open a browser:
.INDENT 0.0
.INDENT 3.5
\fBnikola serve \-b\fP
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
Nikola is a static website and blog generator. The very short
explanation is that it takes some texts you wrote, and uses them to
create a folder full of HTML files. If you upload that folder to a
server, you will have a rather full\-featured website, done with little
effort.
.sp
Its original goal is to create blogs, but it supports most kind of
sites, and can be used as a CMS, as long as what you present to the
user is your own content instead of something the user generates.
.sp
Nikola can do:
.INDENT 0.0
.IP \(bu 2
A blog
.IP \(bu 2
Your company\(aqs site
.IP \(bu 2
Your personal site
.IP \(bu 2
A software project\(aqs site
.IP \(bu 2
A book\(aqs site
.UNINDENT
.sp
Since Nikola\-based sites don\(aqt run any code on the server, there is no
way to process user input in forms.
.sp
Nikola can\(aqt do:
.INDENT 0.0
.IP \(bu 2
Twitter
.IP \(bu 2
Facebook
.IP \(bu 2
An Issue tracker
.IP \(bu 2
Anything with forms, really (except for comments!)
.UNINDENT
.sp
Keep in mind that "static" doesn\(aqt mean \fBboring\fP\&. You can have
animations, slides or whatever fancy CSS/HTML5 thingie you like. It
only means all that HTML is generated already before being uploaded.
On the other hand, Nikola sites will tend to be content\-heavy. What
Nikola is good at is at putting what you write out there.
.SH COMMANDS
.sp
The most basic commands needed to get by are:
.INDENT 0.0
.TP
.B \fBnikola help\fP
get a list of commands, or help for a command
.TP
.B \fBnikola version [\-\-check]\fP
print version number
.TP
.B \fBnikola init [\-d|\-\-demo] [\-q|\-\-quiet] folder\fP
initialize new site
.TP
.B \fBnikola build\fP
build a site
.TP
.B \fBnikola new_post\fP
create a new post
.TP
.B \fBnikola new_page\fP
create a new page
.TP
.B \fBnikola status [\-\-list\-drafts] [\-\-list\-modified] [\-\-list\-scheduled]\fP
show site and deployment status
.TP
.B \fBnikola check [\-v] (\-l [\-\-find\-sources] [\-r] | \-f [\-\-clean\-files])\fP
check for dangling links or unknown files
.TP
.B \fBnikola deploy [[preset [preset...]]\fP
deploy the site using the \fBDEPLOY_COMMANDS\fP setting
.TP
.B \fBnikola github_deploy\(ga\fP
deploy the site to GitHub Pages
.TP
.B \fBnikola serve [\-p PORT] [\-a ADDRESS] [\-d|\-\-detach] [\-b|\-\-browser] [\-6|\-\-ipv6]\fP
start development web server
.TP
.B \fBnikola auto [\-p PORT] [\-a ADDRESS] [\-b|\-\-browser] [\-6|\-\-ipv6]\fP
start development web server with automated rebuilds and reloads
.TP
.B \fBnikola plugin [options]\fP
manage plugins from the Plugins Index (\fI\%https://plugins.getnikola.com/\fP)
.TP
.B \fBnikola install_theme [name]\fP
install themes from the Themes Index (\fI\%https://themes.getnikola.com/\fP)
.UNINDENT
.sp
Use \fBnikola help\fP to get a list of all commands.
.SH BUGS
.sp
Issue Tracker: \fI\%https://github.com/getnikola/nikola/issues\fP
.SH SEE ALSO
.INDENT 0.0
.IP \(bu 2
The Nikola Website: \fI\%https://getnikola.com/\fP
.IP \(bu 2
Handbook: \fI\%https://getnikola.com/handbook.html\fP
.IP \(bu 2
Support: \fI\%https://getnikola.com/contact.html\fP
.UNINDENT
.\" Generated by docutils manpage writer.
.