search

getnikola / plugins

Extra plugins for Nikola
https://plugins.getnikola.com/
MIT License
59 stars 95 forks source link

upgrade_metadata lacks README #154

Closed ParaplegicRacehorse closed 8 years ago

ParaplegicRacehorse commented 8 years ago

There is currently no indication on what upgrade_metadata does, what options can be set in conf.py, or anything else for that matter. Would someone be kind enough to write a README? Else, can it be integrated into core and removed from the plugins directory?

tritium21 commented 8 years ago

Integrating it into Nikola core would probably be a bad idea - upgrade code really shouldn't live in core.

for those who are better at technical writing than I am... getnikola/nikola#1692 getnikola/nikola#1689 https://github.com/getnikola/nikola/blame/master/nikola/post.py#L1000

Kwpolska commented 8 years ago

Added README.md:

This is a plugin to upgrade metadata in .meta files from the old format (without descriptions) to the new reST-esque format. It only applies to users with two-file posts (.meta files alongside text) in the older format (up to 7 lines of text without any descriptions), used by Nikola before v7.0.0. If you need to use this plugin, you will be warned by nikola build — otherwise, there is no need to install it.