https://github.com/pelican-plugins/read-more

Pelican plugin that inserts an inline "Read More" link into the last HTML element of the summary
https://github.com/pelican-plugins/read-more

Last synced: 2 days ago
JSON representation

Pelican plugin that inserts an inline "Read More" link into the last HTML element of the summary

• Host: GitHub
• URL: https://github.com/pelican-plugins/read-more
• Owner: pelican-plugins
• Created: 2021-03-09T08:03:46.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-07T18:47:33.000Z (4 months ago)
• Last Synced: 2024-10-02T19:36:03.787Z (about 1 month ago)
• Language: Python
• Homepage:
• Size: 21.5 KB
• Stars: 1
• Watchers: 4
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

• awesome-pelican - read-more - read-more)](https://pypi.org/project/pelican-read-more) | [pelican-plugins](https://github.com/pelican-plugins) | Pelican plugin that inserts an inline "Read More" link into the last HTML element of the summary (Plugins / Migrated to new architecture)

README

        
Read More: A Plugin for Pelican

===============================

[![Build Status](https://img.shields.io/github/actions/workflow/status/pelican-plugins/read-more/main.yml?branch=main)](https://github.com/pelican-plugins/read-more/actions)

[![PyPI Version](https://img.shields.io/pypi/v/pelican-read-more)](https://pypi.org/project/pelican-read-more/)

![License](https://img.shields.io/pypi/l/pelican-read-more?color=blue)

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 = 'continue'

The following setting defines the format of the “Read More” link:

    READ_MORE_LINK_FORMAT = '{text}'

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.

[existing issues]: https://github.com/pelican-plugins/read-more/issues

[Contributing to Pelican]: https://docs.getpelican.com/en/latest/contribute.html

Contributors

------------

Contributors include: [Vuong Nguyen](https://www.vuongnguyen.com), Dashie, [Justin Mayer](https://justinmayer.com), Kernc, [Dominik Wombacher](https://dominik.wombacher.cc)

License

-------

This project is licensed under the AGPL 3.0 license.