Metadata-Version: 2.4
Name: minchin.pelican.plugins.nojekyll
Version: 1.2.1
Summary: Pelican plugin that adds a `.nojekyll` file to the output root. Useful for publishing to Github Pages. Written in Python.
Author-email: William Minchin <w_minchin@hotmail.com>
Maintainer-email: William Minchin <w_minchin@hotmail.com>
License-Expression: MIT
Project-URL: Bug Tracker, https://github.com/pelican-plugins/nojekyll/issues
Project-URL: Repository, https://github.com/pelican-plugins/nojekyll
Project-URL: Changelog, https://github.com/pelican-plugins/nojekyll/blob/master/CHANGELOG.rst
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Framework :: Pelican :: Plugins
Classifier: Programming Language :: Python :: 3
Classifier: Natural Language :: English
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/x-rst
License-File: Licence.txt
Requires-Dist: pelican
Requires-Dist: minchin.pelican.plugins.autoloader!=1.2.0
Provides-Extra: build
Requires-Dist: minchin.releaser>=0.8.2; extra == "build"
Provides-Extra: lint
Requires-Dist: black; extra == "lint"
Requires-Dist: isort; extra == "lint"
Dynamic: license-file

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

|pypi|

.. |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

Assuming you are running Pelican v4.5 (or later), the plugin with
auto-activate. 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.
