.. title: Documentation
.. slug: documentation
.. date: 2012/12/31 20:40:41
.. tags:
.. link:
.. description:
.. author: The Nikola Team

.. class:: lead

Here is all the documentation for Nikola.  Note that it applies to the latest
release, so it may not be accurate if you’re using an older version, or are
using an unstable version. If you want to read the documentation for the
current GitHub master, check out `Nikola on ReadTheDocs
<http://nikola.readthedocs.org/en/latest/>`_.

`The Handbook <handbook.html>`_
    Aimed at those wanting to *use* Nikola to build a site.

`Getting Started <getting-started.html>`_
    How to set up Nikola.

`The conf.py file <conf.html>`_
    This is the default configuration file for the latest version of Nikola.
    It contains some useful documentation not mentioned in the manual, and can
    be used for people upgrading to compare with their existing config files.

`Upgrading to Nikola v8 </blog/upgrading-to-nikola-v8.html>`_
    A blog post detailing all the changes from Nikola v7.

`Changelog <changes.html>`_, `Contributors <authors.html>`_, `The MIT License <license.html>`_
    What’s new, who made this, and the rules for distribution.

`Creating Custom Pages <creating-a-custom-page.html>`__
    How to do custom pages for special purposes, with special templates and styling.

`Theming Tutorial <creating-a-theme.html>`_, `Theming reference <theming.html>`_, `Template variables <template-variables.html>`_
    Useful if you want to create or customize a theme.

`Extending Nikola <extending.html>`_ and `Nikola Internals <internals.html>`_
    Aimed at those wanting to add new functionality.

`Features <features/index.html>`_
    A list of some Nikola features.

`Creating a Site that is not a blog <creating-a-site-not-a-blog-with-nikola.html>`_
    Not everything is a blog!

`Path handlers documentation <path-handlers.html>`_
    Documentation for path handlers (``link://`` scheme).

`Using Social Buttons <social_buttons.html>`_
    Replacing AddThis with other solutions.

`Automating Nikola rebuilds with GitHub Actions </blog/automating-nikola-rebuilds-with-github-actions.html>`_
    Blogging anywhere with Nikola, GitHub Actions and GitHub Pages.

**Community content:**

`Writing Task Plugins <https://bryanwweber.com/writing/personal/2018/12/22/writing-task-plugins-for-nikola/>`_ and `Controlling plugin task execution order <https://bryanwweber.com/writing/personal/2018/12/20/controlling-plugin-task-execution-order-in-nikola/>`_
    Tutorials about writing custom task plugins for Nikola.

`Tutorial by Tim van der Linden <http://shisaa.jp/postset/nikola-web.html>`_
    Goes from installing to developing a custom theme.

`Tutorial en español de Diego Leonardo Puente <https://web.archive.org/web/20140820013813/http://diegoduncan21.github.io/posts/asi-lo-hice.html>`_
    Instalación y deployment a GitHub

`Tutorial by RCA (in Chinese) <http://rca.is-programmer.com/2013/2/5/using-nikola-write-static-blog.37513.html>`_
    Covers installation and getting started

`Wordpress migration tutorial by Niko Wenselowski (in German) <http://blog.nerdno.de/posts/20130314-wordpress_zu_nikola.html>`_
    He wrote most of the Wordpress importer so he knows ;-)

`Moving from Octopress to Nikola <http://serialized.net/2013/03/moving-from-octopress-to-nikola/>`_
    Since we don't have an automated tool...

`ikiwiki to nikola: the script <https://www.grulic.org.ar/~mdione/glob/posts/ikiwiki-to-nikola-the-script/>`_
    A tool to migrate Markdown posts from ikiwiki to Nikola (with support for footnotes, tags, images and code snippets)