Technical documentation often incurs the usage of many acronyms, which may need additional explanation, especially for new user of your project. For these matters, Material for MkDocs uses a combination of Markdown extensions to enable site-wide glossaries.
This configuration enables abbreviations and allows to build a simple
project-wide glossary, sourcing definitions from a central location. Add the
following line to
See additional configuration options:
Abbreviations can be defined by using a special syntax similar to URLs and
footnotes, starting with a
* and immediately followed by the term or
acronym to be associated in square brackets:
The HTML specification is maintained by the W3C.
Adding a glossary¶
It's highly recommended to put the Markdown file containing the abbreviations outside of the
docsfolder (here, a folder with the name
includesis used), as MkDocs might otherwise complain about an unreferenced file. ↩
建立日期: 2022-05-14 19:18:23