https://github.com/minchinweb/minchin.pelican.plugins.cname

Pelican plugin that adds a `CNAME` file to the output root. Useful for publishing to Github Pages. Written in Python.
https://github.com/minchinweb/minchin.pelican.plugins.cname

cname github-pages pelican pelican-plugins

Last synced: 10 months ago
JSON representation

Pelican plugin that adds a `CNAME` file to the output root. Useful for publishing to Github Pages. Written in Python.

• Host: GitHub
• URL: https://github.com/minchinweb/minchin.pelican.plugins.cname
• Owner: minchinweb
• License: agpl-3.0
• Created: 2016-09-12T21:44:36.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-01-11T21:14:33.000Z (over 2 years ago)
• Last Synced: 2025-03-26T01:51:09.513Z (about 1 year ago)
• Topics: cname, github-pages, pelican, pelican-plugins
• Language: Python
• Size: 43 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: License.txt

Awesome Lists containing this project

README

          
=====

CName

=====

``CName`` is a plugin for `Pelican `_, 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

`_ on a `custom domain

`_.

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

`_ by `Dmitriy Kalinin

`_.