Conflict between Code annotations and markdown-exec lib

[gabrielbdornas]

Context

I'm trying to build a series of python tutorials and think it will be nice to have the result of the code block execution in a result table. For this, I found the markdown-exec to help me.

I'm my current project, as I'm working in tutorials, I've been using code annotations a lot.

After install and configuring markdown-exec within markdown_extensions property, the code annotations stopped working.

So, the code results are working, but the cool code annotations option crash:

Bug description

To me seems a kind of conflict betwwen the code annotations config and the markdown-exec.

• When I do not add markdown-exec options to my code block, the annotations works:

• When add markdown-exec options to my code block, it starts to work, but the annotations crash (exec="1" source="tabbed-left"):

Related links

• Reporting a bug
• FR: Editable code blocks issue.
• Run PythonCode on a docu side discussion.

Reproduction

The problem could be seen at this branch of my code.

Steps to reproduce

1. Clone the code.
2. Install requirements with pip install -r requirements.txt.
3. Rum mkdocs serve.
4. Viste the page located at http://localhost:8000/blog/python-course---class-1/#your-first-python-program

Obs.: The conflicted code is located at this file.

Browser

No response

Before submitting

• I have read and followed the bug reporting guidelines.
• I have attached links to the documentation, and possibly related issues and discussions.
• I assure that I have removed all customizations before submitting this bug report.
• I have attached a .zip file with a minimal reproduction using the built-in info plugin.

[squidfunk]

Thanks for reporting. Since we do not officially support markdown-exec, I'm converting this to a discussion and tagging @pawamoy for visibility. If we can make it work, happy to review a PR that adds the relevant changes, but we're currently frying much, much bigger fish that we cannot budget time to add support for additional third-party libraries 🤟

[squidfunk]

Also note that providing a minimal reproduction is absolutely essential for us and other maintainers to look into it. You haven't provided one but ticked the box. Please provide one, so that somebody can find some motivation and time to help you.

[gabrielbdornas]

Thanks for reporting. Since we do not officially support markdown-exec, I'm converting this to a discussion and tagging @pawamoy for visibility. If we can make it work, happy to review a PR that adds the relevant changes, but we're currently frying much, much bigger fish that we cannot budget time to add support for additional third-party libraries 🤟

@squidfunk, appreciate your time and effort to answer this so quickly. One more time, I want to take advantage of the opportunity to say that the lib is outstanding! Thank you all so much!

[pawamoy]

The issue is probably the following:

• markdown-exec reads your code block and executes it
• then it prepares Markdown markup that wraps both the source and the result in tabs
• then it renders everything and returns that (HTML)
• in the end, your bullet list is not right after your code block anymore: the code block is within the tab structure, but the bullet list is outside
• MfM only supports code annotations when the bullet list is right after the code block
• therefore the code annotations logic breaks

I don't see a solution yet, will think about it.

[squidfunk]

Great analysis and explanation, thanks! I guess both features kind of overlap then, and this particularly becomes a problem because they are mounted/executed at different stages.