File tree Expand file tree Collapse file tree 1 file changed +5
-1
lines changed Expand file tree Collapse file tree 1 file changed +5
-1
lines changed Original file line number Diff line number Diff line change @@ -215,14 +215,18 @@ import tensorflow as tf
215215Annotations offer a comfortable and friendly way to attach explanations to
216216arbitrary sections of code blocks by adding simple markers within block/inline
217217comments that refer to items of a list following the code block, i.e. `(1)`,
218- ` (2)` , etc. Material for MkDocs removes the list from the flow of the document,
218+ ` (2)` , etc. Material for MkDocs detaches the list from the flow of the document,
219219injects the content of each list item into a tooltip, and links each list marker
220220to the corresponding tooltip.
221221
222222In order to opt-in to annotation support, a slightly different syntax is
223223required – just add the respective [language short code][17] and the `.annotate`
224224class, after the three backticks.
225225
226+ Note that annotations can be __placed anywhere__ in a code block where a comment
227+ for the language can be placed, which for JavaScript is `// (1)` and
228+ ` /* (2) */` , for Yaml `# (3)`, etc.
229+
226230_Example_ :
227231
228232` ` ` ` markdown
You can’t perform that action at this time.
0 commit comments