nikola(1)

1NIKOLA(1)                        User Commands                       NIKOLA(1)
2
3
4

NAME

6       Nikola - A Static Site and Blog Generator
7

SYNOPSIS

9       Create an empty site (with a setup wizard):
10          nikola init mysite
11
12       (You  can  create  a site with demo files in it with nikola init --demo
13       mysite)
14
15       Create a post (inside the mysite directory):
16          nikola new_post
17
18       Build the site:
19          nikola build
20
21       Start the test server and open a browser:
22          nikola serve -b
23

DESCRIPTION

25       Nikola is a static website and blog generator. The very short  explana‐
26       tion  is  that it takes some texts you wrote, and uses them to create a
27       folder full of HTML files. If you upload that folder to a  server,  you
28       will have a rather full-featured website, done with little effort.
29
30       Its  original  goal  is  to  create blogs, but it supports most kind of
31       sites, and can be used as a CMS, as long as what  you  present  to  the
32       user is your own content instead of something the user generates.
33
34       Nikola can do:
35
36       • A blog
37
38       • Your company's site
39
40       • Your personal site
41
42       • A software project's site
43
44       • A book's site
45
46       Since  Nikola-based sites don't run any code on the server, there is no
47       way to process user input in forms.
48
49       Nikola can't do:
50
51       • Twitter
52
53       • Facebook
54
55       • An Issue tracker
56
57       • Anything with forms, really (except for comments!)
58
59       Keep in mind that "static" doesn't mean boring.  You  can  have  anima‐
60       tions,  slides  or  whatever  fancy CSS/HTML5 thingie you like. It only
61       means all that HTML is generated already before being uploaded.  On the
62       other  hand, Nikola sites will tend to be content-heavy. What Nikola is
63       good at is at putting what you write out there.
64

COMMANDS

66       The most basic commands needed to get by are:
67
68       nikola help
69              get a list of commands, or help for a command
70
71       nikola version [--check]
72              print version number
73
74       nikola init [-d|--demo] [-q|--quiet] folder
75              initialize new site
76
77       nikola build
78              build a site
79
80       nikola new_post
81              create a new post
82
83       nikola new_page
84              create a new page
85
86       nikola status [--list-drafts] [--list-modified] [--list-scheduled]
87              show site and deployment status
88
89       nikola check [-v] (-l [--find-sources] [-r] | -f [--clean-files])
90              check for dangling links or unknown files
91
92       nikola deploy [[preset [preset...]]
93              deploy the site using the DEPLOY_COMMANDS setting
94
95       nikola github_deploy [-m COMMIT_MESSAGE]`
96              deploy the site to GitHub Pages
97
98       nikola  serve  [-p  PORT]  [-a  ADDRESS]  [-d|--detach]  [-b|--browser]
99       [-6|--ipv6]
100              start development web server
101
102       nikola auto [-p PORT] [-a ADDRESS] [-b|--browser] [-6|--ipv6]
103              start development web server with automated rebuilds and reloads
104
105       nikola plugin [options]
106              manage     plugins     from     the     Plugins     Index     (‐
107              https://plugins.getnikola.com/)
108
109       nikola theme [options]
110              manage     themes     from     the     Themes      Index      (‐
111              https://themes.getnikola.com/)
112
113       Use nikola help to get a list of all commands.
114

BUGS

116       Issue Tracker: https://github.com/getnikola/nikola/issues
117

NAME

SYNOPSIS

DESCRIPTION

COMMANDS

BUGS

SEE ALSO