Skip to content

Support multiple instances of the same plugin#3027

Merged
oprypin merged 4 commits intomasterfrom
inst
Nov 1, 2022
Merged

Support multiple instances of the same plugin#3027
oprypin merged 4 commits intomasterfrom
inst

Conversation

@oprypin
Copy link
Copy Markdown

@oprypin oprypin commented Oct 29, 2022

E.g.:

plugins:
  - blog:
      blog_dir: blog
  - blog:
      blog_dir: tutorial

Depending on what a plugin does, say if it "adds a thing" into the site, it can be reasonable to allow it to be specified multiple times in the plugins: list, so it can "add multiple things". Previously such a use case was completely not predicted in MkDocs, so it silently passes but is bugged - the plugin runs twice but with only one of the configs both times.

So, this PR addresses that by registering a plugin - foo: as 'foo', and then if another plugin - foo: appears, it gets registered as 'foo #2' (the name affects primarily just how it's referred to in warnings and errors).

By default, a warning will appear from MkDocs anyway, unless the plugin adds a class variable supports_multiple_instances = True.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant