sambuc/pelican-plugins
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fixed typos in README

Browse Source
This commit is contained in:
Alistair Magee
2014-02-01 18:21:56 +00:00
parent f3549dd296
commit b86be87c61
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
clean_summary/README.md
View File

@@ -9,26 +9,26 @@ There is also an option to include a minimum of one image.
##Settings## ##Settings##
plugin has two settings. `CLEAN_SUMMARY_MAXIMUM` which takes an int, and This 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_MINIMUM_ONE` which takes a boolean. They default to 0 and False.
`CLEAN_SUMMARY_MAXIMUM` sets the maximum number of images that will appear in `CLEAN_SUMMARY_MAXIMUM` sets the maximum number of images that will appear in
your summary. your summary.
if `CLEAN_SUMMARY_MINIMUM_ONE` is set to `True` and your summary doesn't already 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 contain an image, the plugin will add the first image in your article (if one
exists) to the beginning of the summary. exists) to the beginning of the summary.
##Requirements## ##Requirements##
requires Beautiful Soup Requires Beautiful Soup:
pip install BeautifulSoup4 pip install BeautifulSoup4
##Usage with Summary Plugin## ##Usage with Summary Plugin##
if using the summary plugin, make sure summary appears in your plugins before If using the summary plugin, make sure summary appears in your plugins before
clean summary. Eg. clean summary. Eg.
PLUGINS = ['summary', 'clean_summary', ... ] PLUGINS = ['summary', 'clean_summary', ... ]