search

pelican-plugins / sitemap

Generates a site map for Pelican-powered sites
50 stars 11 forks source link

Remove outdated plugin configuration docs from README #5

Closed ivanhercaz closed 3 years ago

ivanhercaz commented 4 years ago

Hi everyone, If the plugin is installed with pip it should be inserted in PLUGINS with the value pelican.plugins.sitemap. I think it should be specified in the example, don't you think?

I am open to any suggestion!

justinmayer commented 4 years ago

Hey Ivan. 👋🏻 According to the relevant docs, the short name should be accepted just fine, so the reason for this proposed change is not clear to me.

But even the existing docs here shouldn’t be necessary since namespace plugins should be automatically registered, so I think the entire PLUGINS and PLUGIN_PATH setting-related stuff can be removed from the README.

ivanhercaz commented 4 years ago

Ups! Really interesting. I really like this new plugins system. I proposed it because I tried the name of the plugin in PLUGINS and it didn't works, but I don't tried to just write the configuration. Tomorrow I will try it.

And you are agree, according to the docs, both settings should be removed from the example so I can adapt this PR or close it and open a new one.

Thank you for the information, @justinmayer !

justinmayer commented 4 years ago

No need to open a new PR — re-purposing this one would be just fine. As noted above, I recommend removing the outdated information, such that the first line of the displayed default setting would be: SITEMAP = {

getup8 commented 3 years ago

@justinmayer I just downloaded this in a Pelican 4.5.4 project, added just the SITEMAP setting to my pelicanconf.py file but it doesn't do anything, no sitemap is created. Any ideas?

EDIT: sorry, stupid mistake (didn't pop up as a new file in git since output/ isn't being tracked), works great!

justinmayer commented 3 years ago

Addressed via c2c15f3.