https://github.com/pelican-plugins/nojekyll
Pelican plugin that adds a `.nojekyll` file to the output root. Useful for publishing to Github Pages. Written in Python.
https://github.com/pelican-plugins/nojekyll
github-pages pelican pelican-plugins
Last synced: 7 days ago
JSON representation
Pelican plugin that adds a `.nojekyll` file to the output root. Useful for publishing to Github Pages. Written in Python.
- Host: GitHub
- URL: https://github.com/pelican-plugins/nojekyll
- Owner: pelican-plugins
- License: mit
- Created: 2016-09-12T21:18:37.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-06-17T23:11:56.000Z (10 months ago)
- Last Synced: 2025-03-24T16:23:10.494Z (23 days ago)
- Topics: github-pages, pelican, pelican-plugins
- Language: Python
- Homepage:
- Size: 33.2 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
Awesome Lists containing this project
- awesome-pelican - nojekyll - plugins](https://github.com/pelican-plugins) | Pelican plugin that adds a `.nojekyll` file to the output root. Useful for publishing to Github Pages. Written in Python (Plugins / Migrated to new architecture)
README
========
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 `_,
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 `_ 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.