Skip to content

Commit 363ba4e

Browse files
committed
Documentation
1 parent 6f69e3c commit 363ba4e

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

docs/reference/tooltips.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -133,28 +133,29 @@ The HTML specification is maintained by the W3C.
133133
### Adding a glossary
134134

135135
The [Snippets] extension can be used to implement a simple glossary by moving
136-
all abbreviations in a dedicated file[^1], and embedding it with the
137-
[`--8<--` notation][Snippets notation] at the end of each document:
136+
all abbreviations in a dedicated file[^1], and [auto-append] this file with the
137+
following configuration:
138138

139139
[^1]:
140140
It's highly recommended to put the Markdown file containing the
141141
abbreviations outside of the `docs` folder (here, a folder with the name
142142
`includes` is used), as MkDocs might otherwise complain about an
143143
unreferenced file.
144144

145-
=== ":octicons-file-code-16: docs/example.md"
146-
147-
```` markdown
148-
The HTML specification is maintained by the W3C.
149-
150-
--8<-- "includes/abbreviations.md"
151-
````
152-
153145
=== ":octicons-file-code-16: includes/abbreviations.md"
154146

155147
```` markdown
156148
*[HTML]: Hyper Text Markup Language
157149
*[W3C]: World Wide Web Consortium
158150
````
159151

160-
[Snippets notation]: https://facelessuser.github.io/pymdown-extensions/extensions/snippets/#snippets-notation
152+
=== ":octicons-file-code-16: mkdocs.yml"
153+
154+
```` yaml
155+
markdown_extensions:
156+
- pymdownx.snippets:
157+
auto_append:
158+
- includes/abbreviations.md
159+
````
160+
161+
[auto-append]: https://facelessuser.github.io/pymdown-extensions/extensions/snippets/#auto-append-snippets

0 commit comments

Comments
 (0)