New in master

Bugfixes

* Mark as failed tasks when filters fail (Issue #2169)

New in v7.7.5

if ``GITHUB_COMMIT_SOURCE`` is set to True (Issue #2186)

* Hugo-like shortcodes (Issue #1707)

* New Galician translation

* New facilities for data persistence and data caching (Issues #2209 and #2009)

* (internal) allow ``scripts/jinjify.py`` usage with scripts (Issue #2240)

Extending Nikola

================

:Author: Roberto Alsina <ralsina@netmanagers.com.ar>

.. class:: alert alert-info pull-right

A Static Site and Blog Generator

:Manual section: 1

:Manual group: User Commands

The Nikola Handbook

===================

.. class:: alert alert-info pull-right

Using a shortcode

~~~~~~~~~~~~~~~~~

The first word is always the name of the shortcode. Parameters follow the name. Depending upon how the shortcode is defined, the parameters may be named, positional or both. The format for named parameters models that of HTML with the format name="value".

Some shortcodes use or require closing shortcodes. Like HTML, the opening and closing shortcodes match (name only), the closing being prepended with a slash.

Example of a paired shortcode (note that we don't have a highlight shortcode yet ;-)::

Built-in shortcodes

~~~~~~~~~~~~~~~~~~~

post-list

Will show a list of posts, see the `Post List directive for details <#post-list>`__

Template-based shortcodes

~~~~~~~~~~~~~~~~~~~~~~~~~

If you put a template in ``shortcodes/`` called ``mycode.tmpl`` then Nikola will create a shortcode

for that template. If you use the shortcode as paired, then the contents between the paired tags will

be available in the ``data`` variable.

And your post contains this::

Then the output file will contain::

.. sidebar:: Creating your own filters

You can use any program name that works in place as a filter, like ``sed -i``

For example, this is how the yui_compressor filter is implemented:

.. code-block:: python

def yui_compressor(infile):

return runinplace(r'yui-compressor --nomunge %1 -o %2', infile)

.. slug: path-handlers

.. author: The Nikola Team

.. class:: dl-horizontal

Example:

tag

Using Alternative Social Buttons with Nikola

============================================

.. class:: alert alert-info pull-right

Theming Nikola

==============

:Author: Roberto Alsina <ralsina@netmanagers.com.ar>

.. class:: alert alert-info pull-right

from __future__ import absolute_import

import os

DEBUG = bool(os.getenv('NIKOLA_DEBUG'))

from .nikola import Nikola # NOQA

# output / TRANSLATION[lang] / INDEX_PATH / index-*.html

# INDEX_PATH = ""

# Create per-month archives instead of per-year

# CREATE_MONTHLY_ARCHIVE = False

# Create one large archive instead of per-year

#

# If set to False, it will sort by filename instead. Defaults to True

# GALLERY_SORT_BY_DATE = True

#

# Folders containing images to be used in normal posts or pages. Images will be

# scaled down according to IMAGE_THUMBNAIL_SIZE and MAX_IMAGE_SIZE options, but

{% block content %}

{% block content_header %}{% endblock %}

<div class="postindex">

{% for post in posts %}

<article class="h-entry post-{{ post.meta('type') }}">

<%block name="content">

<%block name="content_header"></%block>

<div class="postindex">

% for post in posts:

<article class="h-entry post-${post.meta('type')}">

image_ext_list_builtin = ['.jpg', '.png', '.jpeg', '.gif', '.svg', '.bmp', '.tiff']

"""Make a copy of the image in the requested size."""

if not Image or os.path.splitext(src)[1] in ['.svg', '.svgz']:

self.resize_svg(src, dst, max_size, bigger_panoramas)

exif = im._getexif()

except Exception:

exif = None

if exif is not None:

for tag, value in list(exif.items()):

decoded = ExifTags.TAGS.get(tag, tag)

break

try:

im.thumbnail(size, Image.ANTIALIAS)

except Exception as e:

self.logger.warn("Can't thumbnail {0}, using original "

"image as thumbnail ({1})".format(src, e))

'FILES_FOLDERS': {'files': ''},

'FILTERS': {},

'FORCE_ISO8601': False,

'GALLERY_FOLDERS': {'galleries': 'galleries'},

'GALLERY_SORT_BY_DATE': True,

'GLOBAL_CONTEXT_FILLER': [],

'POSTS_SECTION_FROM_META': False,

'POSTS_SECTION_NAME': "",

'POSTS_SECTION_TITLE': "{name}",

'PAGES': (("stories/*.txt", "stories", "story.tmpl"),),

'PANDOC_OPTIONS': [],

'PRETTY_URLS': False,

'BODY_END',

'EXTRA_HEAD_DATA',

'NAVIGATION_LINKS',

'INDEX_READ_MORE_LINK',

'FEED_READ_MORE_LINK',

'INDEXES_TITLE',

'posts_section_descriptions',

'posts_section_name',

'posts_section_title',

)

# WARNING: navigation_links SHOULD NOT be added to the list above.

# Themes ask for [lang] there and we should provide it.

# FIXME TemplateSystem should not be needed

if p[-1].details.get('Nikola', 'PluginCategory') not in {'Command', 'Template'}:

bad_candidates.add(p)

# Remove compilers we don't use

if p[-1].name in self.bad_compilers:

bad_candidates.add(p)

self._GLOBAL_CONTEXT['show_blog_title'] = self.config.get('SHOW_BLOG_TITLE')

self._GLOBAL_CONTEXT['logo_url'] = self.config.get('LOGO_URL')

self._GLOBAL_CONTEXT['blog_description'] = self.config.get('BLOG_DESCRIPTION')

self._GLOBAL_CONTEXT['color_hsl_adjust_hex'] = utils.color_hsl_adjust_hex

self._GLOBAL_CONTEXT['colorize_str_from_base_color'] = utils.colorize_str_from_base_color

def register_shortcode(self, name, f):

"""Register function f to handle shortcode "name"."""

if name in self.shortcode_registry:

return

self.shortcode_registry[name] = f

results = [p for p in self.timeline if p.meta('slug') == name]

if not results:

def write_content(cls, filename, content, rewrite_html=True):

"""Write content to file."""

if rewrite_html:

else:

content = content.encode('utf-8')

utils.makedirs(os.path.dirname(filename))

with open(filename, "wb+") as fd:

fd.write(content)

@staticmethod

def write_metadata(filename, title, slug, post_date, description, tags, **kwargs):

"""Write metadata to meta file."""