pelican-plugins/clean_summary/README.md

#Clean Summary Plugin#

Plugin to clean your summary of excess images. Images can take up much more space than text and lead to summaries being different sizes on archive and index pages. With this plugin you can specify a maximum number of images that will appear in your summaries.

There is also an option to include a minimum of one image.

##Settings##

plugin has two settings. CLEAN_SUMMARY_MAXIMUM which takes an int, and CLEAN_SUMMARY_MINIMUM_ONE which takes a boolean. They deafult to 0 and False.

CLEAN_SUMMARY_MAXIMUM sets the maximum number of images that will appear in your summary.

if CLEAN_SUMMARY_MINIMUM_ONE is set to True and your summary doesn't already contain an image, the plugin will add the first image in your article(if one exists) to the beginning of the summary.

##Requirements##

requires Beautiful Soup

pip install BeautifulSoup4

##Usage with Summary Plugin##

if using the summary plugin, make sure summary appears in your plugins before clean summary. Eg.

PLUGINS = ['summary', 'clean_summary', ... ]