Metadata-Version: 2.1
Name: minchin.pelican.plugins.nojekyll
Version: 1.1.1
Summary: Pelican plugin that adds a `.nojekyll` file to the output root. Useful for publishing to Github Pages. Written in Python.
Home-page: https://github.com/MinchinWeb/minchin.pelican.plugins.nojekyll
Author: W. Minchin
Author-email: w_minchin@hotmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Framework :: Pelican :: Plugins
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/x-rst
License-File: Licence.txt

========
NoJekyll
========

|build| |pypi|

.. |build| image:: https://img.shields.io/github/workflow/status/pelican-plugins/nojekyll/build
    :target: https://github.com/pelican-plugins/nojekyll/actions
    :alt: Build Status

.. |pypi| image:: https://img.shields.io/pypi/v/minchin.pelican.plugins.nojekyll.svg
    :target: https://pypi.python.org/pypi/minchin.pelican.plugins.nojekyll
    :alt: PyPI Version

``NoJekyll`` is a plugin for `Pelican <http://docs.getpelican.com/>`_,
a static site generator written in Python.

``NoJekyll`` creates a *.nojekyll* file in the root of your output directory.
This is useful when you are publishing your site to
`GitHub Pages <https://pages.github.com/>`_ as it keeps your site from being
run through GitHub's default Jekyll site generator. This has a side effect
of make your updated site go live faster.


Installation
============

The easiest way to install ``NoJekyll`` is through the use of pip. This
will also install the required dependencies automatically.

.. code-block:: sh

  pip install minchin.pelican.plugins.nojekyll

Then, in your ``pelicanconf.py`` file, add ``NoJekyll`` to your list of
plugins:

.. code-block:: python

  PLUGINS = [
      # ...
      'minchin.pelican.plugins.nojekyll',
      # ...
  ]

And that's it! No further configuration is needed.


Usage
=====

No configuration is needed.

The ``NoJekyll`` plugin will be automatically called next time you generate
your Pelican site.


