Annotations/comments for Code Blocks
M
Murray Bauer
Ability to add annotations/comments in a code block as pictured.
Currently a new feature in MKDocs for Material:
Markdown format to achieve:
``` yaml
theme:
features:
- content.code.annotate # (1)!
```
- :man_raising_hand: I'm a code annotation! I can contain code, __formatted
text__, images, ... basically anything that can be written in Markdown.
Photo Viewer
View photos in a modal
rick Rode
The flexibility to include formatted text, images, and other Markdown content makes annotations a powerful tool for creating more interactive and beginner-friendly documentation. Features like this can significantly improve the learning experience by helping readers understand not just what the code does, but why it works. Much like I learn new techniques while playing Ragdoll Hit, well-placed code annotations can make complex concepts easier to grasp and more enjoyable to explore.
T
Traky D
Would appreciate this feature implemented too! Would be a useful addition.
George R.
I would also greatly appreciate this as It can be great when trying to explain code instead of having to refer to lines or sections in the code