Metadata-Version: 2.1
Name: minchin.pelican.plugins.cname
Version: 1.2.1
Summary: Pelican plugin that adds a `CNAME` file to the output root. Useful for publishing to Github Pages. Written in Python.
Home-page: https://github.com/MinchinWeb/minchin.pelican.plugins.cname
Author: William Minchin
Author-email: w_minchin@hotmail.com
License: AGPL-3.0
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Environment :: Console
Classifier: Framework :: Pelican :: Plugins
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Description-Content-Type: text/x-rst
Requires-Dist: pelican
Provides-Extra: all
Requires-Dist: minchin.releaser; extra == 'all'
Requires-Dist: pip-tools; extra == 'all'
Provides-Extra: build
Requires-Dist: minchin.releaser; extra == 'build'
Requires-Dist: pip-tools; extra == 'build'
Provides-Extra: docs
Provides-Extra: test

=====
CName
=====

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

``CName`` creates a *CNAME* file in the root of your output directory. This
is useful when you are publishing your site to
`GitHub Pages <https://pages.github.com/>`_ on a
`custom domain <https://help.github.com/articles/using-a-custom-domain-with-github-pages/>`_.


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

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

.. code-block:: sh

  pip install minchin.pelican.plugins.cname

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

.. code-block:: python

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

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


Usage
=====

No configuration is needed. The value places in the *CNAME* files is based
on your ``SITEURL`` setting.


Credits
=======

Based on the `original code <https://github.com/getpelican/pelican-plugins/pull/566>`_
by `Dmitriy Kalinin <http://lazycoder.ru/>`_.


