OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
squidfunk 2021-03-14 19:13:31 +01:00
parent 29ddccec5a
commit 6f63baa95a
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/reference/code-blocks.md
View File

@ -215,7 +215,7 @@ import tensorflow as tf
Annotations offer a comfortable and friendly way to attach explanations to Annotations offer a comfortable and friendly way to attach explanations to
arbitrary sections of code blocks by adding simple markers within block/inline arbitrary sections of code blocks by adding simple markers within block/inline
comments that refer to items of a list following the code block, i.e. `(1)`, comments that refer to items of a list following the code block, i.e. `(1)`,
`(2)`, etc. Material for MkDocs removes the list from the flow of the document, `(2)`, etc. Material for MkDocs detaches the list from the flow of the document,
injects the content of each list item into a tooltip, and links each list marker injects the content of each list item into a tooltip, and links each list marker
to the corresponding tooltip. to the corresponding tooltip.
@ -223,6 +223,10 @@ In order to opt-in to annotation support, a slightly different syntax is
required – just add the respective [language short code][17] and the `.annotate` required – just add the respective [language short code][17] and the `.annotate`
class, after the three backticks. class, after the three backticks.
Note that annotations can be __placed anywhere__ in a code block where a comment
for the language can be placed, which for JavaScript is `// (1)` and
`/* (2) */`, for Yaml `# (3)`, etc.
_Example_: _Example_:
```` markdown ```` markdown