mkdocs/catalog

Suggested plugin config for Material for MkDocs will always fail

squidfunk opened this issue · 1 comments

squidfunk commented

Configuration Change:

theme: material
plugins:
  - info
  - offline
  - search
  - social
  - tags

The info plugin will always terminate the build, it is solely used for reproduction of issues. Also, the offline plugin should always be used with an environment variable, because it will switch off use_directory_urls and copy the search index to a JavaScript file.

Suggested change

theme: material
plugins:
  - search
  - social
  - tags
oprypin commented

Hi. Thanks for the comment.

This is not meant to be a suggested config to be wholly copied, rather be seen as a collection of snippets to copy as needed.
For example, under the bootswatch theme collection it is "suggested" to enable 15 themes at once, which indeed doesn't work.

But it is true that this intent is not described anywhere. Suggestions are welcome on how to clarify this.

And the info plugin should probably indeed be dropped from here.