Metadata-Version: 2.4
Name: minchin.pelican.plugins.clean_with_comments
Version: 1.0.0
Summary: Remove chunks of generated pages and articles with comments. For Pelican.
Author-email: William Minchin <w_minchin@hotmail.com>
Maintainer-email: William Minchin <w_minchin@hotmail.com>
License-Expression: MIT
Project-URL: Bug Tracker, https://github.com/MinchinWeb/minchin.pelican.plugins.clean_with_comments/issues
Project-URL: Repository, https://github.com/MinchinWeb/minchin.pelican.plugins.clean_with_comments
Project-URL: Changelog, https://github.com/MinchinWeb/minchin.pelican.plugins.clean_with_comments/blob/master/CHANGELOG.rst
Keywords: pelican,plugin
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Plugins
Classifier: Framework :: Pelican
Classifier: Framework :: Pelican :: Plugins
Classifier: Intended Audience :: End Users/Desktop
Classifier: Operating System :: OS Independent
Classifier: Topic :: Text Processing
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/x-rst
Requires-Dist: pelican
Requires-Dist: minchin.pelican.plugins.autoloader
Provides-Extra: dev
Requires-Dist: minchin.releaser; extra == "dev"
Requires-Dist: pip-tools; extra == "dev"
Requires-Dist: markdown; extra == "dev"

"Clean with Comments" Plugin for Pelican
========================================

This is a plugin for Pelican, designed to allow you to clean (or surpress)
parts of the generated site. It is intended to be used with pairs of HTML
comments.

This cleaning can happen multiple times within the same file. This cleaning is
applied to both articles and pages. Cleaning happens after just about every
other part of Pelican has run, so this is on the (near) file output. One
implication of this is your summary for acticles is generated with the (later)
removed text in place.

Log messages from this plugin are prefixed with ``[Cleaner]``.

Pelican Settings
----------------

CLEANER_START_MARKER = "<!-- CLEANER_START -->"
  Marker of where to start cleaning from. Must have a matching end marker; c.f.
  ``CLEANER_START_MARKER``. These are fed into Python's regex engine, so regex
  (rather than just plain) strings may work.
CLEANER_END_MARKER = "<!-- CLEANER_END -->"
  See ``CLEANER_BEGIN_MARKER``.
CLEANER_ENCODING = "utf-8"
  File encoding to use when reading files from disk.
