doc: fix improper code blocks parsing for lua_api_deploy by using pymdown-extensions #13847
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR replaces the default fenced code blocks extension with a workaround extension, pymdown-extension's superfences. As I don't have experience with deploying on github pages, i was only able to verify this locally and see that the codeblock for
minetest.features
is rendered as expected.Notes
Minetest uses mkdocs to build documentation, which in turn uses python-markdown which then notes:
With this in mind, the project does not implement fenced code blocks like ```lua .. ``` used currently in
doc/
. This feature is brought in by mkdocs using fenced_code_blocks extension which doesn't support nesting it inside container blocks (i.e. lists) or even having any indentation to the whole block. furthermore, changes todoc/
from someone expecting a full commonmark implementation may result in improper formatting.