Skip to content
Permalink
Browse files
Nikola v8.0.0rc1
Signed-off-by: Chris Warrick <kwpolska@gmail.com>
  • Loading branch information
Kwpolska committed Sep 8, 2018
1 parent bc387a3 commit 8e993a544861b67fdb1f177d9fec861328d636a8
@@ -76,6 +76,7 @@
# tr Turkish [NOT tr_TR]
# uk Ukrainian
# ur Urdu
# vi Vietnamese
# zh_cn Chinese (Simplified)
# zh_tw Chinese (Traditional)
#
@@ -156,6 +157,9 @@

# Theme configuration. Fully theme-dependent. (translatable)
# Examples below are for bootblog4.
# bootblog4 supports: featured_large featured_small featured_on_mobile
# featured_large_image_on_mobile featured_strip_html sidebar
# bootstrap4 supports: navbar_light (defaults to False)
THEME_CONFIG = {
DEFAULT_LANG: {
# Show the latest featured post in a large box, with the previewimage as its background.
@@ -333,9 +337,6 @@
# already contains the text), set this to False.
# SHOW_BLOG_TITLE = True

# Writes tag cloud data in form of tag_cloud_data.json.
WRITE_TAG_CLOUD = False

# Paths for different autogenerated bits. These are combined with the
# translation paths.

@@ -377,7 +378,7 @@
# }

# If you do not want to display a tag publicly, you can mark it as hidden.
# The tag will not be displayed on the tag list page, the tag cloud and posts.
# The tag will not be displayed on the tag list page and posts.
# Tag pages will still be generated.
HIDDEN_TAGS = ['mathjax']

@@ -1216,7 +1217,9 @@
# Should titles fetched from file metadata be unslugified (made prettier?)
# FILE_METADATA_UNSLUGIFY_TITLES = True

# If enabled, extract metadata from docinfo fields in reST documents
# If enabled, extract metadata from docinfo fields in reST documents.
# If your text files start with a level 1 heading, it will be treated as the
# document title and will be removed from the text.
# USE_REST_DOCINFO_METADATA = False

# If enabled, hide docinfo fields in reST document output
@@ -1268,9 +1271,9 @@
# # 'creator': '@username', # Username for the content creator / author.
# }

# If webassets is installed, bundle JS and CSS into single files to make
# site loading faster in a HTTP/1.1 environment but is not recommended for
# HTTP/2.0 when caching is used. Defaults to True.
# Bundle JS and CSS into single files to make site loading faster in a HTTP/1.1
# environment but is not recommended for HTTP/2.0 when caching is used.
# Defaults to True.
# USE_BUNDLES = True

# Plugins you don't want to use. Be careful :-)
@@ -1309,12 +1312,6 @@
# (defaults to 1.)
# DEMOTE_HEADERS = 1

# Docutils, by default, will perform a transform in your documents
# extracting unique titles at the top of your document and turning
# them into metadata. This surprises a lot of people, and setting
# this option to True will prevent it.
# NO_DOCUTILS_TITLE_TRANSFORM = False

# If you don’t like slugified file names ([a-z0-9] and a literal dash),
# and would prefer to use all the characters your file system allows.
# USE WITH CARE! This is also not guaranteed to be perfect, and may
@@ -0,0 +1,75 @@
.. title: Nikola v8.0.0rc1 is out!
.. slug: nikola-v800rc1-is-out
.. date: 2018-09-08 18:55:34 UTC
.. tags: nikola, planet, python, programming, release
.. category:
.. link:
.. description:
.. type: text
.. author: Chris Warrick

On behalf of the Nikola team, I am pleased to announce the immediate
availability of Nikola v8.0.0rc1. This is the end of the road to Nikola
version 8. Within 48 hours, assuming there are no grave bugs reported in that
timeframe, we intend to release v8 final.

What is Nikola?
===============

Nikola is a static site and blog generator, written in Python.
It can use Mako and Jinja2 templates, and input in many popular markup
formats, such as reStructuredText and Markdown — and can even turn
Jupyter Notebooks into blog posts! It also supports image galleries,
and is multilingual. Nikola is flexible, and page builds are extremely
fast, courtesy of doit (which is rebuilding only what has been changed).

Find out more at the website: https://getnikola.com/

Downloads
=========

Install using ``pip install Nikola==8.0.0rc1``.

If you want to upgrade to Nikola v8, make sure to read `the Upgrading blog post <https://getnikola.com/blog/upgrading-to-nikola-v8.html>`_.

Changes
=======

Features
--------

* Add Vietnamese translation by Hoai-Thu Vuong
* Don’t generate gallery index if the destination directory is
site root and it would conflict with blog index (Issue #3133)
* All built-in themes now support ``updated`` timestamp fields in
posts. The update time, if it is specified and different from
the posting time, will be displayed as
"{postDate} (${messages("updated")} {updateDate})". If no update
time is specified, the posting time will be displayed alone.
* All built-in themes now support the ``DATE_FANCINESS`` option.
* Theme bundles are now parsed using the configparser module and
can support newlines inside entries as well as comments
* Make bootstrap4 navbar color configurable with
``THEME_CONFIG['navbar_light']`` (Issue #2863)

Bugfixes
--------

* Use UTF-8 instead of system encoding for gallery metadata.yml file
* Do not remove first heading in document (reST document title)
if ``USE_REST_DOCINFO_METADATA`` is disabled (Issue #3124)
* Remove ``NO_DOCUTILS_TITLE_TRANSFORM`` setting,
this is now default behavior if ``USE_REST_DOCINFO_METADATA``
is disabled (Issue #2382, #3124)
* Enforce trailing slash for directories in ``nikola auto``
(Issue #3140)
* Galleries with baguetteBox don’t glitch out on the first image
anymore (Issue #3141)

Removed features
----------------

* Moved ``tag_cloud_data.json`` generation to a separate
``tagcloud`` plugin (Issue #1696)
* The ``webassets`` library is no longer required, we now manually
bundle files (Issue #3074)
@@ -1,3 +1,3 @@
{
"last_deploy": "2018-09-08T18:32:39.799108"
"last_deploy": "2018-09-08T19:00:46.915701"
}
@@ -1,11 +1,53 @@
New in v8.0.0b3 (changes since Beta 2)
======================================
New since Beta 3
================

.. to be merged into one "new in v8.0.0" entry later
Features
--------

* Add Vietnamese translation by Hoai-Thu Vuong
* Don’t generate gallery index if the destination directory is
site root and it would conflict with blog index (Issue #3133)
* All built-in themes now support ``updated`` timestamp fields in
posts. The update time, if it is specified and different from
the posting time, will be displayed as
"{postDate} (${messages("updated")} {updateDate})". If no update
time is specified, the posting time will be displayed alone.
* All built-in themes now support the ``DATE_FANCINESS`` option.
* Theme bundles are now parsed using the configparser module and
can support newlines inside entries as well as comments
* Make bootstrap4 navbar color configurable with
``THEME_CONFIG['navbar_light']`` (Issue #2863)

Bugfixes
--------

* Use UTF-8 instead of system encoding for gallery metadata.yml file
* Do not remove first heading in document (reST document title)
if ``USE_REST_DOCINFO_METADATA`` is disabled (Issue #3124)
* Remove ``NO_DOCUTILS_TITLE_TRANSFORM`` setting,
this is now default behavior if ``USE_REST_DOCINFO_METADATA``
is disabled (Issue #2382, #3124)
* Enforce trailing slash for directories in ``nikola auto``
(Issue #3140)
* Galleries with baguetteBox don’t glitch out on the first image
anymore (Issue #3141)

Removed features
----------------

* Moved ``tag_cloud_data.json`` generation to a separate
``tagcloud`` plugin (Issue #1696)
* The ``webassets`` library is no longer required, we now manually
bundle files (Issue #3074)

New in v8.0.0b3 (changes since Beta 2)
======================================

Features
--------

* New data_file option for chart shortcode and directive (Issue #3129)
* Show the filename of the missing file when ``nikola serve`` can't
find a file (i.e. when an 404 error occurs).
@@ -18,6 +60,7 @@ Features
Bugfixes
--------

* Pass arguments to youtube directive unchanged (Issue #3150)
* Fix listing installed themes if theme directory is missing.
* Watch correct output folder in ``nikola auto`` (Issue #3119)
* Fix post fragment dependencies when posts are only available in a
@@ -1,11 +1,11 @@
.. title: Nikola v8.0.0b3 configuration file
.. title: Nikola v8.0.0rc1 configuration file
.. slug: conf
.. date: 2014-11-08 18:51:30 UTC
.. description: The Nikola configuration file.
.. type: text
.. author: The Nikola Team
The default config file for Nikola v8.0.0b3 is reproduced below.
The default config file for Nikola v8.0.0rc1 is reproduced below.

.. raw:: html

@@ -813,15 +813,33 @@ Doing the same for layout-reverse, sidebar-overlay and the rest is left as an ex
Bundles
-------

If you have ``webassets`` installed and the ``USE_BUNDLES`` option set to True, Nikola can put several CSS or JS files together in a larger file,
which makes sites load faster. To do that, your theme needs a ``bundles`` file where the syntax is::

outputfile1.js=thing1.js,thing2.js,...
outputfile2.css=thing1.css,thing2.css,...

For the Lanyon theme, it should be like this::

assets/css/all.css=rst_base.css,nikola_rst.css,code.css,poole.css,lanyon.css,custom.css
If the ``USE_BUNDLES`` option set to True,
Nikola can put several CSS or JS files together in a larger file, which can
makes site load faster for some deployments. To do this, your theme needs
a ``bundles`` file. The file format is a modified
`config <https://docs.python.org/3/library/configparser.html>`_ file with no
defined section; the basic syntax is::

outputfile1.js=
thing1.js,
thing2.js,
...
outputfile2.css=
thing1.css,
thing2.css,
...

For the Lanyon theme, it should look like this::

assets/css/all.css=
rst_base.css,
nikola_rst.css,
code.css,
poole.css,
lanyon.css,
custom.css,

**Note:** trailing commas are optional

**Note:** Some themes also support the ``USE_CDN`` option meaning that in some cases it will load one bundle with all CSS and in other will load some CSS files
from a CDN and others from a bundle. This is complicated and probably not worth the effort.
@@ -9,7 +9,7 @@
Extending Nikola
================

:Version: 8.0.0b3
:Version: 8.0.0rc1
:Author: Roberto Alsina <ralsina@netmanagers.com.ar>

.. class:: alert alert-primary float-md-right
@@ -10,13 +10,7 @@
The Nikola Handbook
===================

:Version: 8.0.0b3

.. class:: alert alert-warning

This handbook is for Nikola v8.0.0b3. See also: `v7.8.15 handbook
<https://getnikola.com/handbook-v7.html>`_, `upgrading to v8
<https://getnikola.com/blog/upgrading-to-nikola-v8.html>`_.
:Version: 8.0.0rc1

.. class:: alert alert-primary float-md-right

@@ -180,7 +174,6 @@ Nikola provides the following features:
* Author pages and feeds (not generated if ``ENABLE_AUTHOR_PAGES`` is set to ``False`` or there is only one author)
* Archives with custom granularity (yearly or monthly)
* `Comments`_
* Client-side tag clouds (needs manual configuration)

* Static pages (not part of the blog)
* `Math`_ rendering (via MathJax)
@@ -533,7 +526,13 @@ To do this, you need ``USE_REST_DOCINFO_METADATA = True`` in your ``conf.py``,
and Nikola will hide the docinfo fields in the output if you set
``HIDE_REST_DOCINFO = True``.

Note that keys are converted to lowercase automatically.
.. note::

Keys are converted to lowercase automatically.

This setting also means that the first heading in a post will be removed
and considered a title. This is important if you’re mixing metadata
styles. This can be solved by putting a reST comment before your title.

Markdown metadata
`````````````````
@@ -1035,7 +1034,7 @@ Please note that tags are case-sensitive and that you cannot have two tags that
ERROR: Nikola: Tag Nikola is used in: posts/second-post.rst
ERROR: Nikola: Tag nikola is used in: posts/1.rst

You can also generate a tag cloud with the `tx3_tag_cloud <https://plugins.getnikola.com/#tx3_tag_cloud>`_ plugin.
You can also generate a tag cloud with the `tx3_tag_cloud <https://plugins.getnikola.com/v7/tx3_tag_cloud/>`_ plugin or get a data file for a tag cloud with the `tagcloud <https://plugins.getnikola.com/v7/tagcloud/>`_ plugin.

Categories
``````````
@@ -1057,7 +1056,6 @@ There are multiple configuration variables dedicated to each of the two taxonomi
* ``TAG_DESCRIPTIONS``, ``CATEGORY_DESCRIPTIONS`` to set descriptions for each of the items
* ``CATEGORY_ALLOW_HIERARCHIES`` and ``CATEGORY_OUTPUT_FLAT_HIERARCHIES`` to allow hierarchical categories
* ``TAG_PAGES_ARE_INDEXES`` and ``CATEGORY_PAGES_ARE_INDEXES`` to display full-size indexes instead of simple post lists
* ``WRITE_TAG_CLOUDS`` to enable/disable generating tag cloud files
* ``HIDDEN_TAGS``. ``HIDDEN_CATEGORIES`` to make some tags/categories invisible in lists
* ``CATEGORY_DESTPATH_AS_DEFAULT`` to use the destination path as the category if none is specified in the post
* ``CATEGORY_DESTPATH_TRIM_PREFIX`` to trim the prefix that comes from ``POSTS`` for the destination path
@@ -2348,7 +2346,7 @@ different ones, or about other web servers, please share!
4. Optionally you can create static compressed copies and save some CPU on your server
with the GZIP_FILES option in Nikola.

5. The webassets Nikola plugin can drastically decrease the number of CSS and JS files your site fetches.
5. The bundles Nikola plugin can drastically decrease the number of CSS and JS files your site fetches.

6. Through the filters feature, you can run your files through arbitrary commands, so that images
are recompressed, JavaScript is minimized, etc.
@@ -9,7 +9,7 @@
Using Alternative Social Buttons with Nikola
============================================

:Version: 8.0.0b3
:Version: 8.0.0rc1

.. class:: alert alert-primary float-md-right

@@ -4,7 +4,7 @@
.. description: Get help using Nikola, or contact us.
.. author: The Nikola Team
:Version: 8.0.0b3
:Version: 8.0.0rc1

.. class:: alert alert-primary float-md-right

@@ -3,7 +3,7 @@
.. date: 2017-04-13 12:00:00
.. author: The Nikola Team
:Version: 8.0.0b3
:Version: 8.0.0rc1
:Author: Chris Warrick <chris@getnikola.com>

Variables available in templates are listed below.

0 comments on commit 8e993a5

Please sign in to comment.