fralau / mkdocs-macros-plugin

Create richer and more beautiful pages in MkDocs, by using variables and calls to macros in the markdown code.
https://mkdocs-macros-plugin.readthedocs.io
Other
336 stars 51 forks source link

Issue with mkdocs material rendering connected to the macros plugin in the latest update #84

Closed AntonKInv closed 3 years ago

AntonKInv commented 3 years ago

Hello Fralau,

First and foremost, thank you very much for your brilliant and versatile mkdocs Macros plugin! We've been using it for many months. There is a macros plugin issue that emerged some time ago that I need to report. Presumably, it is caused by an incompatibility between the latest Mkdocs or Material theme version and the Macros plugin.

The latest configuration that worked well was as follows: Mkdocs==1.1 Mkdocs-material==7.0.6 Mkdocs-macros-plugin==0.4.4

If Mkdocs gets updated to version 1.2, on pages generation we get broken layouts, as if the Material theme does not get applied:

layout

If we disable the macros plugin in mkdocs.yml file, rendering works as expected.

Please let us know if there might be a workaround or a fix. Thank you in advance!

github-actions[bot] commented 3 years ago

Welcome to this project and thank you!' first issue

fralau commented 3 years ago

That is odd... I am using mkdocs 1.1.2 and mkdocs-material 7.0.6. without any problem.

Is your project using other plugins that could interfere? Or else, is there some macro or action in the main.pythat could interfere?

Perhaps you could give the relevant parts of your mkdocs.yml (plugins, extensions, etc.).

AntonKInv commented 3 years ago

Hi. Thank you for your response. No, there is not much in the configuration. We've checked this on two clean PCs and we reproduced the issue on both, we also tried it without mkdocs custom_dir: overrides

plugins:

markdown_extensions:

theme: name: material custom_dir: overrides language: 'en' logo: 'assets/images/white.svg' palette: primary: 'green' accent: 'blue' font: text: 'Roboto' code: 'Roboto Mono' favicon: 'assets/images/icon.ico' features:

The full config: image

fralau commented 3 years ago

Hmm... 🤔 I don't think that the culprit is either material or macros-plugin, but that something else is interfering.

Off the bat: try to declare the search plugin before the macros plugin in your config file? (According to the documentation, the declaration should be in that order).

Or, just to "wiggle" a little, try to remove the search plugin and see whether it works? Or to remove the arguments from the search plugin?

Or else, try to remove everything but mkdocs-material and mkdocs-macros, and try to rebuild from there?

AntonKInv commented 3 years ago

Hi again. Thank you for the tips! We've found the cause, it was our custom mkdocs overrides configuration. Sorry for the false alarm.

fralau commented 3 years ago

My pleasure! When something unexpected happen, it is an opportunity for all of us to learn something new.

Can we close the issue?