1
0
Fork 0
summary_footnotes/README.md

37 lines
1.0 KiB
Markdown

#Summary Footnotes Plugin#
Plugin to fix footnote references in your summary. By default, they are
broken links because the footnotes are not included with the summary.
This plugin lets you either remove the links or make them point to the
full article page.
This plugin was based off the [clean_summary][clean_summary] and
[ssummary][ssumary] plugins.
##Settings##
This plugin has one setting, `SUMMARY_FOOTNOTES_MODE` which takes a string.
The two available modes are `"remove"` which removes all footnote links
from summaries and `"link"` (the default) which changes footnote links
in summaries to link to the footnote on the article page.
##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', 'summary_footnotes', ... ]
[clean_summary]: https://github.com/getpelican/pelican-plugins/tree/master/clean_summary
[ssumary]: https://gist.github.com/l04m33/7e93b0bb3ca0cfc6f2d0