Skip to main content

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.

Metadata

Release files for minchin.pelican.plugins.clean-with-comments 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for minchin.pelican.plugins.clean-with-comments 1.0.0
File Size Uploaded
minchin_pelican_plugins_clean_with_comments-1.0.0.tar.gz 4.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for minchin.pelican.plugins.clean-with-comments 1.0.0
File Interpreter ABI Platform
minchin_pelican_plugins_clean_with_comments-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 8.7 kB

Release files / minchin_pelican_plugins_clean_with_comments-1.0.0.tar.gz

Download URL minchin_pelican_plugins_clean_with_comments-1.0.0.tar.gz
Size 4.3 kB
Tags Source
SHA-256 checksum
How to use checksums
dd9be201eeb19bff7e7ce319ed543555b804ef2834b3a49b4d11b131de7a0ece
BLAKE2b-256 checksum
How to use checksums
d8b41fe610081fed99ac51a43a4ca40068f9c25796817981bf4867cf37314fbb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.0

Release files / minchin_pelican_plugins_clean_with_comments-1.0.0-py3-none-any.whl

Download URL minchin_pelican_plugins_clean_with_comments-1.0.0-py3-none-any.whl
Size 4.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7cdcb66f406b5656411d1d185ccdb364136a51f3369f4ebe8e63e92d6ed09970
BLAKE2b-256 checksum
How to use checksums
29c9d60c1f08f43b2909fe10223ad31f2c579537d31d338579e241039f313c48
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.0

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page