minchin.pelican.plugins.clean-with-comments 1.0.0

Remove chunks of generated pages and articles with comments. 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.