search

pelican-plugins / series

Series is a Pelican plugin that joins multiple posts into a series
11 stars 4 forks source link

README doesn't mention loading the plugin #29

Closed mpounsett closed 1 year ago

mpounsett commented 1 year ago

The installation instructions in the README don't mention loading the plugin.

justinmayer commented 1 year ago

As noted in my comment in the corresponding PR, the installation instructions don't mention enabling the plugin because by default the plugin will be automatically detected, registered, and enabled without any action by the end user — provided that the PLUGINS setting has not been explicitly defined by the end user.

In line with language I have added to other plugin READMEs, via 2d6cf2d I have added a paragraph to this plugin's README to make that fact more visible, along with a link to the relevant documentation that clearly explains this behavior.