search

timvink / mkdocs-git-revision-date-localized-plugin

MkDocs plugin to add a last updated date to your site pages
https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/index.html
MIT License
206 stars 44 forks source link

'locale' is not a valid option at the mkdocs configuration level #24

Closed Guts closed 4 years ago

Guts commented 4 years ago

According to the README, locale value can be set in two hierarchical ways:

  1. plugins/git-revision-date-localized configuration
  2. if not, fallback to the theme section

When not set, this plugin will look for locale or language options set in your theme. If also not set, the fallback is English (en)

But in fact, the plugin is also looking for a locale option at the mkdocs level:

https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/blob/b6647efc74161682354992430fe609704193624a/mkdocs_git_revision_date_localized_plugin/plugin.py#L41

Problem: this option is not an accepted one in MkDocs configuration.

Sp, plugin should not look at this option.

timvink commented 4 years ago

Actually, this is done on purpose, as locale might be added to mkdocs in a future release. (Can't find the related issue now but have this from waylan himself)

timvink commented 4 years ago

Here is the reference comment from waylan, explaining locale might be part of mkdocs in the future.

Thanks for the suggestion though, really appreciate you looking for areas where the plugin can be improved !