Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: getnikola/nikola-site
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: a734b4aa6eec
Choose a base ref
...
head repository: getnikola/nikola-site
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 72ced9317151
Choose a head ref
  • 6 commits
  • 7 files changed
  • 1 contributor

Commits on Jul 10, 2015

  1. Update navbar with new pages 

    Signed-off-by: Chris Warrick <kwpolska@gmail.com>
    @Kwpolska
    Kwpolska committed Jul 10, 2015
    Copy the full SHA
    b564e04 View commit details

  2. Update horribly outdated document 

    Signed-off-by: Chris Warrick <kwpolska@gmail.com>
    @Kwpolska
    Kwpolska committed Jul 10, 2015
    Copy the full SHA
    244a5b2 View commit details

  3. Move quickstart TOC to the right 

    Signed-off-by: Chris Warrick <kwpolska@gmail.com>
    @Kwpolska
    Kwpolska committed Jul 10, 2015
    Copy the full SHA
    e4aef04 View commit details

  4. Add license page 

    Signed-off-by: Chris Warrick <kwpolska@gmail.com>
    @Kwpolska
    Kwpolska committed Jul 10, 2015
    Copy the full SHA
    76197ae View commit details

  5. Fix code blocks in Getting Started

    @Kwpolska
    Kwpolska committed Jul 10, 2015
    Copy the full SHA
    3368c9c View commit details

  6. Deduplicate manual, use syntax highlighting everywhere 

    Signed-off-by: Chris Warrick <kwpolska@gmail.com>
    @Kwpolska
    Kwpolska committed Jul 10, 2015
    Copy the full SHA
    72ced93 View commit details
Showing with 266 additions and 354 deletions.
  1. +3 −1 conf.py
  2. +20 −18 stories/getting-started.html
  3. +2 −2 stories/index.html
  4. +45 −0 stories/license.rst
  5. +194 −331 stories/manual.txt
  6. +1 −1 stories/quickstart.rst
  7. +1 −1 stories/theming.txt
4 changes: 3 additions & 1 deletion conf.py
View file
Original file line number Diff line number Diff line change
@@ -183,12 +183,14 @@
(
(
('/documentation.html', '<strong>Documentation Index</strong>'),
('/getting-started.html', '<strong>Getting Started</strong>'),
('/handbook.html', '<strong>Handbook</strong>'),
('/conf.html', 'conf.py'),
('/creating-a-theme.html', 'Theming Tutorial'),
('/extending.html', 'Extending'),
('/internals.html', 'Internals'),
('/creating-a-site-not-a-blog-with-nikola.html', 'Creating a Site (Not a Blog)')
('/creating-a-site-not-a-blog-with-nikola.html', 'Creating a Site (Not a Blog)'),
('/license.html', 'License'),
),
'Documentation',
),
38 changes: 20 additions & 18 deletions stories/getting-started.html
View file
Original file line number Diff line number Diff line change
@@ -21,6 +21,7 @@ <h2 id="install">Step 1. Install Nikola</h2>
<li>Some distributions also have Nikola packaged in its repositories — but please make sure it’s a fresh version.</li>
</ul>
</p>
<p class="text-muted">Nikola is free open-source software, under the <a href="/license.html">MIT license</a>.</p>
<div class="panel-group" id="accordion" role="tablist" aria-multiselectable="true">
<div class="panel panel-default">
<div class="panel-heading" role="tab" id="headingWindows">
@@ -36,7 +37,7 @@ <h4 class="panel-title">
caveats:</p>
<ol class="arabic simple">
<li>You need to install Python yourself.</li>
<li><code class="gs-code">lxml</code> and <code class="gs-code">Pillow</code> require compiled extensions. Compiling them on Windows is hard for most people. Fortunately, compiled packages exist. Check their <a class="reference external" href="https://pypi.python.org/">PyPI</a> pages to find official packages, <a class="reference external" href="http://www.lfd.uci.edu/~gohlke/pythonlibs/">the unofficial Gohlke binaries</a> site, or get them somewhere else.</li>
<li><code class="gs-code">lxml</code> and <code class="gs-code">Pillow</code> require compiled extensions. Compiling them on Windows is hard for most people. Fortunately, compiled packages exist. Check their <a class="reference external" href="https://pypi.python.org/">PyPI</a> pages to find official packages, <a class="reference external" href="http://www.lfd.uci.edu/~gohlke/pythonlibs/">the unofficial Gohlke wheels</a> site, or get them somewhere else.</li>
<li>Windows has some differences over POSIX, which may cause some features to work incorrectly under Windows. If any problems occur, please do not hesitate to report them. Some of the differences include:
<ul>
<li><code class="gs-code">\</code> as path separator (instead of <code class="gs-code">/</code>)</li>
@@ -82,11 +83,11 @@ <h4 class="panel-title">
<div class="panel-body">
<p>If you get errors about various files missing while compiling <code class="gs-code">lxml</code>, you must install headers for the <code class="gs-code">libxml</code>, <code class="gs-code">libxslt</code> and <code class="gs-code">zlib</code> libraries, like so:</p>
<p>Debian systems:</p>
<pre class="gs-console"><code class="gs-code"># <span class="gs-root">sudo apt-get install libxml2-dev libxslt1-dev zlib1g-dev</span></code></pre>
<pre class="gs-console"><code># <span class="gs-root">sudo apt-get install libxml2-dev libxslt1-dev zlib1g-dev</span></code></pre>
<p>Fedora 22+:</p>
<pre class="gs-console"><code class="gs-code"># <span class="gs-root">sudo dnf install libxslt-devel libxml2-devel zlib-devel</span></code></pre>
<pre class="gs-console"><code># <span class="gs-root">sudo dnf install libxslt-devel libxml2-devel zlib-devel</span></code></pre>
<p>Red Hat/CentOS/Fedora 21:</p>
<pre class="gs-console"><code class="gs-code"># <span class="gs-root">sudo yum install libxslt-devel libxml2-devel zlib-devel</span></code></pre>
<pre class="gs-console"><code># <span class="gs-root">sudo yum install libxslt-devel libxml2-devel zlib-devel</span></code></pre>
</div>
</div>
</div>
@@ -103,11 +104,11 @@ <h4 class="panel-title">
<p>If you get an error to the effect of <code class="gs-code">Python.h not found</code>, you need to
install development packages for Python.</p>
<p>Debian systems:</p>
<pre class="gs-console"><code class="gs-code"># <span class="gs-root">sudo apt-get install python-dev</span></code></pre>
<pre class="gs-console"><code># <span class="gs-root">sudo apt-get install python-dev</span></code></pre>
<p>Fedora 22+:</p>
<pre class="gs-console"><code class="gs-code"># <span class="gs-root">sudo dnf install python-devel</span></code></pre>
<pre class="gs-console"><code># <span class="gs-root">sudo dnf install python-devel</span></code></pre>
<p>Red Hat/CentOS/Fedora 21:</p>
<pre class="gs-console"><code class="gs-code"># <span class="gs-root">sudo yum install python-devel</span></code></pre>
<pre class="gs-console"><code># <span class="gs-root">sudo yum install python-devel</span></code></pre>
<p>Note that many other distros/operating systems (including Arch Linux, *BSD and OS X) do not require such packages, as C headers are included with the base distribution of Python.</p>
</div>
</div>
@@ -116,22 +117,22 @@ <h4 class="panel-title">
<div class="panel-heading" role="tab" id="headingGitHub">
<h4 class="panel-title">
<a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion" href="#collapseGitHub" aria-expanded="false" aria-controls="collapseGitHub">
<i class="fa fa-github"></i> Advanced: installing from GitHub
<i class="fa fa-github"></i> Advanced: installing from GitHub (or tarballs)
</a>
</h4>
</div>
<div id="collapseGitHub" class="panel-collapse collapse" role="tabpanel" aria-labelledby="headingGitHub">
<div class="panel-body">
<p>You can also install Nikola from GitHub. This will get you the code that is still under development. It probably has bugs, but there are often new features or bugfixes.</p>
<pre class="gs-console"><code class="gs-code">$ <span class="gs-command">pip install "git+https://github.com/getnikola/nikola#egg=Nikola[extras]"</span></code></pre>
<pre class="gs-console"><code>$ <span class="gs-command">pip install "git+https://github.com/getnikola/nikola#egg=Nikola[extras]"</span></code></pre>
<p>You can also use tarballs downloaded from GitHub, or <span class="gs-command">pip install -e</span> with a local clone.</p>
</div>
</div>
</div>
</div>
</div>
<div class="col-md-5">
<pre class="gs-console"><code class="gs-code">$ <span class="gs-command">virtualenv-3.4 nikola</span>
<pre class="gs-console"><code>$ <span class="gs-command">virtualenv-3.4 nikola</span>
Using base prefix '/usr'
New python executable in nikola/bin/python3
Also creating executable in nikola/bin/python
@@ -151,7 +152,7 @@ <h2 id="init">Step 2. Initialize a site</h2>
<p>To create a site, you need to run <code class="gs-code gs-command">nikola init --demo &lt;directory_name&gt;</code>. A friendly wizard will be launched, letting you configure your site easily. The <code class="gs-code">--demo</code> option is used to fill your site with some demo content. (If you do not want the wizard, use the <code class="gs-code">--quiet</code> argument.)</p>
</div>
<div class="col-md-5">
<pre class="gs-console"><code class="gs-code">$ <span class="gs-command">nikola init --demo my_first_site</span>
<pre class="gs-console"><code>$ <span class="gs-command">nikola init --demo my_first_site</span>
Creating Nikola Site
====================

@@ -176,7 +177,7 @@ <h2 id="build">Step 3. Build your site</h2>
<p>You can now build the site you created. Just run <code class="gs-code gs-command">nikola build</code>. The output directory will then be filled with the contents of your site, which is now <strong>ready to deploy</strong>.</p>
</div>
<div class="col-md-5">
<pre class="gs-console"><code class="gs-code">$ <span class="gs-command">cd my_first_site</span>
<pre class="gs-console"><code>$ <span class="gs-command">cd my_first_site</span>
$ <span class="gs-command">nikola build</span>
Scanning posts....done!
. render_galleries:output/galleries
@@ -205,10 +206,10 @@ <h2 id="newpost">Step 4. Write your first post</h2>
<p>You should make it more interesting and personal. Write your own post!</p>
<p>To do that, you can just use <code class="gs-code gs-command">nikola new_post -e</code>. (The <code class="gs-code">-e</code> option will open the post in your text editor of choice; many more options are available)</p>
<p>The command will create the file for you in the right place, with the metadata headers and a writing prompt.</p>
<p>By default, Nikola creates posts in reStructuredText. To use other markup formats, it needs <a href="#markup">some special configuration</a>.</p>
<p>By default, Nikola creates posts in reStructuredText. You can read <a href="https://getnikola.com/quickstart.html">the reStructuredText Primer</a> to get accustomed to the syntax. You can also use many other input formats; to do this, your site needs <a href="#markup">some special configuration</a>.</p>
</div>
<div class="col-md-5">
<pre class="gs-console"><code class="gs-code">$ <span class="gs-command">nikola new_post -e</span>
<pre class="gs-console"><code>$ <span class="gs-command">nikola new_post -e</span>
Creating New Post
-----------------

@@ -223,10 +224,10 @@ <h2 id="newpost">Step 4. Write your first post</h2>
<h2 id="rebuild">Step 5. Rebuild your site</h2>
<div class="col-md-7">
<p>When you’re done writing your post, you must rebuild your site to make it visible on your site. Run <code class="gs-code gs-command">nikola build</code> again.</p>
<p>Note that the list of files is much <strong>shorter</strong> now: Nikola does <a href="/features/fast.html">fast, incremental rebuilds</a>. Nikola built only the pages for this post, the indexes, the feeds, and the previous post (to add a <em>Next post</em> navigation button). All the demo pages and assets were left <strong>untouched</strong>, saving you time and resources (it does not have to work on building some larger things, and <code class="gs-code">rsync</code> will not have to upload everything)</p>
<p>Note that the list of files is much <strong>shorter</strong> now: Nikola does <a href="/features/fast.html">fast, incremental rebuilds</a> (courtesy of <a href="http://pydoit.org/">doit</a>). Nikola built only the pages for this post, the indexes, the feeds, and the previous post (to add a <em>Next post</em> navigation button). All the demo pages and assets were left <strong>untouched</strong>, saving you time and resources (it does not have to work on building some larger things, and <code class="gs-code">rsync</code> will not have to upload everything)</p>
</div>
<div class="col-md-5">
<pre class="gs-console"><code class="gs-code">$ <span class="gs-command">nikola build</span>
<pre class="gs-console"><code>$ <span class="gs-command">nikola build</span>
Scanning posts....done!
. render_posts:timeline_changes
. render_posts:cache/posts/my-first-blog-post.html
@@ -250,7 +251,7 @@ <h2 id="serve">Step 6. Start the development server</h2>
<p>Run <code class="gs-code gs-command">nikola serve --browser</code> to start the development server and open your site in a web browser. Press <kbd>Ctrl+C</kbd> to stop the server.</p>
</div>
<div class="col-md-5">
<pre class="gs-console"><code class="gs-code">$ <span class="gs-command">nikola serve --browser</span>
<pre class="gs-console"><code>$ <span class="gs-command">nikola serve --browser</span>
INFO: serve: Serving HTTP on 0.0.0.0 port 8000...
INFO: serve: Opening http://0.0.0.0:8000/ in the default web browser...
</code></pre>
@@ -262,7 +263,8 @@ <h3 id="explore">Explore!</h3>
<p>
<ul>
<li>Check out the demo content installed with the site to see what Nikola can do — and that’s not all it has to offer!</li>
<li>Read the <a href="/handbook.html">manual</a> to learn more about Nikola.</li>
<li>Find out what other commands are available by using <code class="gs-command">nikola help</code>.</li>
<li>Read the <strong><a href="/handbook.html">Nikola Handbook</a></strong> to learn more about Nikola.</li>
<li>Edit the <code class="gs-code">conf.py</code> file to your liking.</li>
<li>Check out <a href="https://themes.getnikola.com/">themes</a> and <a href="https://plugins.getnikola.com/">plugins</a> for Nikola, or write your own.</li>
</ul>
4 changes: 2 additions & 2 deletions stories/index.html
View file
Original file line number Diff line number Diff line change
@@ -14,8 +14,8 @@
<div class="container">
<h1>Nikola — Static Site Generator</h1>
<p>In goes content, out comes a website, ready to deploy.</p>
<p><a class="btn btn-primary btn-lg" href="/getting-started.html" role="button">Get started with Nikola &raquo;</a></p>
<p><small>Nikola is written in Python (2.7+/3.3+). Open source software — MIT license.</small></p>
<p><a class="btn btn-primary btn-lg" href="/getting-started.html" role="button">Get started with Nikola &raquo;</a> <a class="btn btn-default btn-lg" href="/getting-started.html" role="button">Learn about Nikola features &raquo;</a></p>
<p><small>Nikola is written in Python (2.7+/3.3+). Free open-source software under the <a href="/license.html">MIT license</a>.</small></p>
</div>
</div>

45 changes: 45 additions & 0 deletions stories/license.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
.. title: The MIT License
.. slug: license
.. date: 2015-07-10 12:40:18 UTC
.. tags:
.. category:
.. link:
.. description:
.. type: text
.. class:: lead

Nikola is released under the MIT license, which is a free software license.
Some components shipped along with Nikola, or required by it are released under
other licenses.

*If you are not familiar with free software licensing: In general, you should be
able to do pretty much anything you want, unless you modify Nikola. If you
modify it, and share it with someone else, that someone else should get all
your modifications under the same license you got it.*

-------------------------------------------------

Copyright © 2012-2015 Roberto Alsina and others.

Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the
Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the
Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice
shall be included in all copies or substantial portions of
the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Loading