Skip to content

Getting started

  • 1. Prerequisites

    This plugin requires the material definition lists to be active or any other plugin which generates html description lists.

  • 2. Installation

    Install the ezglossary plugin whereever you installed mkdocs using the python package manager:

    pip3 install mkdocs-ezglossary-plugin
    
  • 3. Activation

    Add the following lines to your mkdocs.yml plugins-section to activate the plugin:

    plugins:
      - search
      - ezglossary
    
  • 4. Further reading

    Check the usage documentation on how to use your the plugin.