=====
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/>`_.
.. image:: https://img.shields.io/pypi/v/minchin.pelican.plugins.cname.svg?style=flat
:target: https://pypi.python.org/pypi/minchin.pelican.plugins.cname/
:alt: PyPI version number
.. image:: https://img.shields.io/badge/-Changelog-success
:target: https://github.com/MinchinWeb/minchin.pelican.plugins.cname/blob/master/CHANGELOG.rst
:alt: Changelog
.. image:: https://img.shields.io/pypi/pyversions/minchin.pelican.plugins.cname?style=flat
:target: https://pypi.python.org/pypi/minchin.pelican.plugins.cname/
:alt: Supported Python version
.. image:: https://img.shields.io/pypi/l/minchin.pelican.plugins.cname.svg?style=flat&color=green
:target: https://github.com/MinchinWeb/minchin.pelican.plugins.cname/blob/master/License.txt
:alt: License
.. image:: https://img.shields.io/pypi/dm/minchin.pelican.plugins.cname.svg?style=flat
:target: https://pypi.python.org/pypi/minchin.pelican.plugins.cname/
:alt: Download Count
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
If you are using Pelican >= 4.5, the plugin will be automatically activated!
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/>`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/MinchinWeb/minchin.pelican.plugins.cname",
"name": "minchin.pelican.plugins.cname",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "William Minchin",
"author_email": "w_minchin@hotmail.com",
"download_url": "https://files.pythonhosted.org/packages/88/d0/de68e99eaaa7001374731d1c72104622cfccef2ed2f6f65b332834e13705/minchin.pelican.plugins.cname-1.3.4.tar.gz",
"platform": "any",
"description": "=====\r\nCName\r\n=====\r\n\r\n``CName`` is a plugin for `Pelican <http://docs.getpelican.com/>`_, a static\r\nsite generator written in Python.\r\n\r\n``CName`` creates a *CNAME* file in the root of your output directory. This is\r\nuseful when you are publishing your site to `GitHub Pages\r\n<https://pages.github.com/>`_ on a `custom domain\r\n<https://help.github.com/articles/using-a-custom-domain-with-github-pages/>`_.\r\n\r\n\r\n.. image:: https://img.shields.io/pypi/v/minchin.pelican.plugins.cname.svg?style=flat\r\n :target: https://pypi.python.org/pypi/minchin.pelican.plugins.cname/\r\n :alt: PyPI version number\r\n\r\n.. image:: https://img.shields.io/badge/-Changelog-success\r\n :target: https://github.com/MinchinWeb/minchin.pelican.plugins.cname/blob/master/CHANGELOG.rst\r\n :alt: Changelog\r\n\r\n.. image:: https://img.shields.io/pypi/pyversions/minchin.pelican.plugins.cname?style=flat\r\n :target: https://pypi.python.org/pypi/minchin.pelican.plugins.cname/\r\n :alt: Supported Python version\r\n\r\n.. image:: https://img.shields.io/pypi/l/minchin.pelican.plugins.cname.svg?style=flat&color=green\r\n :target: https://github.com/MinchinWeb/minchin.pelican.plugins.cname/blob/master/License.txt\r\n :alt: License\r\n\r\n.. image:: https://img.shields.io/pypi/dm/minchin.pelican.plugins.cname.svg?style=flat\r\n :target: https://pypi.python.org/pypi/minchin.pelican.plugins.cname/\r\n :alt: Download Count\r\n\r\n\r\nInstallation\r\n============\r\n\r\nThe easiest way to install ``CName`` is through the use of pip. This will also\r\ninstall the required dependencies automatically.\r\n\r\n.. code-block:: sh\r\n\r\n pip install minchin.pelican.plugins.cname\r\n\r\nIf you are using Pelican >= 4.5, the plugin will be automatically activated!\r\nAnd that's it! No further configuration is needed.\r\n\r\n\r\nUsage\r\n=====\r\n\r\nNo configuration is needed. The value places in the *CNAME* files is based on\r\nyour ``SITEURL`` setting.\r\n\r\n\r\nCredits\r\n=======\r\n\r\nBased on the `original code\r\n<https://github.com/getpelican/pelican-plugins/pull/566>`_ by `Dmitriy Kalinin\r\n<http://lazycoder.ru/>`_.\r\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "Pelican plugin that adds a `CNAME` file to the output root. Useful for publishing to Github Pages. Written in Python.",
"version": "1.3.4",
"project_urls": {
"Homepage": "https://github.com/MinchinWeb/minchin.pelican.plugins.cname"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3d59138b506bc9e06e1a7b51b31b0243509806346c0fee77d606e2d8fed46b69",
"md5": "e8b55bf250b18d7d729f31f01dd63641",
"sha256": "8d00188aea014287d6a565dabfc2ac86dbb7afbf2e2bdcd2e09944348da05c59"
},
"downloads": -1,
"filename": "minchin.pelican.plugins.cname-1.3.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e8b55bf250b18d7d729f31f01dd63641",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 16027,
"upload_time": "2023-08-09T18:42:55",
"upload_time_iso_8601": "2023-08-09T18:42:55.771474Z",
"url": "https://files.pythonhosted.org/packages/3d/59/138b506bc9e06e1a7b51b31b0243509806346c0fee77d606e2d8fed46b69/minchin.pelican.plugins.cname-1.3.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "88d0de68e99eaaa7001374731d1c72104622cfccef2ed2f6f65b332834e13705",
"md5": "f174307636fe9a99762d06b887d6da26",
"sha256": "af5a64877476c7ea49ee3cb1b1f5537e317615231504611f9ae801460502088d"
},
"downloads": -1,
"filename": "minchin.pelican.plugins.cname-1.3.4.tar.gz",
"has_sig": false,
"md5_digest": "f174307636fe9a99762d06b887d6da26",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 16051,
"upload_time": "2023-08-09T18:42:21",
"upload_time_iso_8601": "2023-08-09T18:42:21.939649Z",
"url": "https://files.pythonhosted.org/packages/88/d0/de68e99eaaa7001374731d1c72104622cfccef2ed2f6f65b332834e13705/minchin.pelican.plugins.cname-1.3.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-09 18:42:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MinchinWeb",
"github_project": "minchin.pelican.plugins.cname",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "minchin.pelican.plugins.cname"
}
JSON
