Mirror of https://github.com/wombelix/read-more - Pelican plugin that inserts an inline "Read More" link into the last HTML element of the summary
Dominik Wombacher
8d22cb4979
Post-migration fixes and minor enhancements
|
il y a 3 ans | |
|---|---|---|
| .github | il y a 3 ans | |
| pelican | il y a 3 ans | |
| .editorconfig | il y a 3 ans | |
| .gitignore | il y a 3 ans | |
| .pre-commit-config.yaml | il y a 3 ans | |
| CONTRIBUTING.md | il y a 3 ans | |
| README.md | il y a 3 ans | |
| pyproject.toml | il y a 3 ans | |
| tasks.py | il y a 3 ans | |
| tox.ini | il y a 3 ans |
README.md
Read More: A Plugin for Pelican
This Pelican plugin inserts an inline “Read More” link into the last HTML element of the summary.
For more information regarding why it was created, please visit: https://www.vuongnguyen.com/read-more-python-lxml/
Installation
This plugin can be installed via:
python -m pip install pelican-read-more
Settings
The following settings are available. If not set, the plugin will use default values.
The following setting defines the string that is added to the end of the summary, before the “Read More” link:
SUMMARY_END_SUFFIX = "..."
The following setting defines the summary length before truncating and adding the “Read More” link:
SUMMARY_MAX_LENGTH = 50
The following setting defines the “Read More” link text:
READ_MORE_LINK = '<span>continue</span>'
The following setting defines the format of the “Read More” link:
READ_MORE_LINK_FORMAT = '<a class="read-more" href="/{url}">{text}</a>'
Contributing
Contributions are welcome and much appreciated. Every little bit helps. You can contribute by improving the documentation, adding missing features, and fixing bugs. You can also help out by reviewing and commenting on existing issues.
To start contributing to this plugin, review the Contributing to Pelican documentation, beginning with the Contributing Code section.
Contributors
Contributors include: Vuong Nguyen, Dashie, Justin Mayer, Kernc
License
This project is licensed under the AGPL-3.0 license.