=====
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": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "William Minchin",
"author_email": "w_minchin@hotmail.com",
"download_url": "https://files.pythonhosted.org/packages/e9/cb/8aed3f0379413378efda7ffdf821eb38790a4556ac39b3ef6cf593ec727f/minchin_pelican_plugins_cname-1.4.0.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.4.0",
"project_urls": {
"Homepage": "https://github.com/MinchinWeb/minchin.pelican.plugins.cname"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "edf89f32c447cb83720d08d2506f850f4d439bda4ee9953b053d2fcc3251c277",
"md5": "b2d8076748134f043e451a6989a8d181",
"sha256": "96616db8552d23758ae40f73c437c5358cbdca8573c2b0893fa8b845436d1179"
},
"downloads": -1,
"filename": "minchin_pelican_plugins_cname-1.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b2d8076748134f043e451a6989a8d181",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 14617,
"upload_time": "2025-10-24T23:22:20",
"upload_time_iso_8601": "2025-10-24T23:22:20.357544Z",
"url": "https://files.pythonhosted.org/packages/ed/f8/9f32c447cb83720d08d2506f850f4d439bda4ee9953b053d2fcc3251c277/minchin_pelican_plugins_cname-1.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e9cb8aed3f0379413378efda7ffdf821eb38790a4556ac39b3ef6cf593ec727f",
"md5": "723066df91a506bd912b636c856308a9",
"sha256": "fbedc4f007df3dc2abef5e1b214e5dcf8c562c5bd3aacc067d70253c38d80f09"
},
"downloads": -1,
"filename": "minchin_pelican_plugins_cname-1.4.0.tar.gz",
"has_sig": false,
"md5_digest": "723066df91a506bd912b636c856308a9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 16254,
"upload_time": "2025-10-24T23:20:28",
"upload_time_iso_8601": "2025-10-24T23:20:28.004574Z",
"url": "https://files.pythonhosted.org/packages/e9/cb/8aed3f0379413378efda7ffdf821eb38790a4556ac39b3ef6cf593ec727f/minchin_pelican_plugins_cname-1.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-24 23:20:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MinchinWeb",
"github_project": "minchin.pelican.plugins.cname",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "anyio",
"specs": [
[
"==",
"4.11.0"
]
]
},
{
"name": "blinker",
"specs": [
[
"==",
"1.9.0"
]
]
},
{
"name": "docutils",
"specs": [
[
"==",
"0.22.2"
]
]
},
{
"name": "feedgenerator",
"specs": [
[
"==",
"2.2.1"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.11"
]
]
},
{
"name": "jinja2",
"specs": [
[
"==",
"3.1.6"
]
]
},
{
"name": "markdown-it-py",
"specs": [
[
"==",
"4.0.0"
]
]
},
{
"name": "markupsafe",
"specs": [
[
"==",
"3.0.3"
]
]
},
{
"name": "mdurl",
"specs": [
[
"==",
"0.1.2"
]
]
},
{
"name": "minchin-pelican-plugins-autoloader",
"specs": [
[
"==",
"1.2.1"
]
]
},
{
"name": "ordered-set",
"specs": [
[
"==",
"4.1.0"
]
]
},
{
"name": "pelican",
"specs": [
[
"==",
"4.11.0"
]
]
},
{
"name": "pygments",
"specs": [
[
"==",
"2.18.0"
]
]
},
{
"name": "python-dateutil",
"specs": [
[
"==",
"2.9.0.post0"
]
]
},
{
"name": "rich",
"specs": [
[
"==",
"14.2.0"
]
]
},
{
"name": "semantic-version",
"specs": [
[
"==",
"2.10.0"
]
]
},
{
"name": "six",
"specs": [
[
"==",
"1.17.0"
]
]
},
{
"name": "sniffio",
"specs": [
[
"==",
"1.3.1"
]
]
},
{
"name": "tzdata",
"specs": [
[
"==",
"2025.2"
]
]
},
{
"name": "unidecode",
"specs": [
[
"==",
"1.4.0"
]
]
},
{
"name": "watchfiles",
"specs": [
[
"==",
"1.1.1"
]
]
}
],
"lcname": "minchin.pelican.plugins.cname"
}
JSON
