https://github.com/opennti/nti.nikola_chameleon

A plugin for the Nikola static blog system to render templates with Chameleon an z3c.pt
https://github.com/opennti/nti.nikola_chameleon

chameleon nikola python template

Last synced: about 21 hours ago
JSON representation

A plugin for the Nikola static blog system to render templates with Chameleon an z3c.pt

• Host: GitHub
• URL: https://github.com/opennti/nti.nikola_chameleon
• Owner: OpenNTI
• License: other
• Created: 2017-10-02T15:19:57.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-04-24T18:06:20.000Z (over 1 year ago)
• Last Synced: 2024-08-10T11:25:41.208Z (3 months ago)
• Topics: chameleon, nikola, python, template
• Language: Python
• Size: 772 KB
• Stars: 1
• Watchers: 4
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE

Awesome Lists containing this project

README

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

 nti.nikola_chameleon

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

.. image:: https://img.shields.io/pypi/v/nti.nikola_chameleon.svg

        :target: https://pypi.org/project/nti.nikola_chameleon/

        :alt: Latest release

.. image:: https://img.shields.io/pypi/pyversions/nti.nikola_chameleon.svg

        :target: https://pypi.org/project/nti.nikola_chameleon/

        :alt: Supported Python versions

.. image:: https://travis-ci.org/NextThought/nti.nikola_chameleon.svg?branch=master

        :target: https://travis-ci.org/NextThought/nti.nikola_chameleon

.. image:: https://coveralls.io/repos/github/NextThought/nti.nikola_chameleon/badge.svg?branch=master

        :target: https://coveralls.io/github/NextThought/nti.nikola_chameleon?branch=master

.. image:: https://readthedocs.org/projects/ntinikola_chameleon/badge/?version=latest

        :target: https://ntinikola_chameleon.readthedocs.io/en/latest/

        :alt: Documentation Status

An extremely flexible template system for the `Nikola

`_ static blog system using

`Chameleon `_, `z3c.pt

`_ and `z3c.macro

`_

A basic template using this system is available in `base-chameleon

`_,

and an extension of that using bootstrap3 is available in

`bootstrap3-chameleon

`_.

Documentation is hosted at https://ntinikola_chameleon.readthedocs.io/

Installation

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

Nikola uses a `custom mechanism `_

to find plugins instead of using the usual ``pkg_resources`` system.

That makes it *incredibly* difficult to install plugins; it's not enough

just to ``pip install`` a package from PyPI. Instead, you must *also*

copy a ``.plugin`` file to a particular location on disk. This can be:

- ~/.nikola/plugins/

- The ``plugins`` directory of your Nikola site.

Beside that '.plugin' file there must also be a '.py' file of the same

name that the plugin lists as a module (yes, even though the plugin file

specifically requests a Python module, yapsy requires that it be a

file or directory beside the plugin file---so not really a module).

It's ridiculous to require everyone to copy plugins into their plugin

folder (they're not even correctly on ``sys.path``, meaning that

zope.configuration and many other tools won't work) and we don't plan

to let Nikola do that automatically (we're not on the Nikola plugin

index and won't be until they let us do standard installs), so the

best we can do is attempt to workaround yapsy's limitations.

Into your site's plugin directory, place the following .py file::

  # nti_nikola_chameleon.py

  from nti.nikola_chameleon import *

Beside that, you'll need a ``nti.nikola_chameleon.plugin`` file::

  # -*- mode: conf; -*-

  [Core]

  Name = nti.nikola_chameleon

  Module = nti_nikola_chameleon

  [Documentation]

  Author = NextThought

  Version = 1.0

  Website = https://github.com/NextThought/nti.nikola_chameleon

  Description = Support for Chameleon ZPT templates.

  [Nikola]

  PluginCategory = Template