Configuration¤

Global/local options¤

The other options can be used both globally and locally, under the options key. For example, globally:

plugins:
- mkdocstrings:
    handlers:
      typescript:
        options:
          do_something: true

...and locally, overriding the global configuration:

::: package.module.class
    options:
      do_something: false

These options affect how the documentation is collected from sources and rendered. See the following tables summarizing the options, and get more details for each option in the following pages:

• General options: various options that do not fit in the other categories
• Headings options: options related to headings and the table of contents (or sidebar, depending on the theme used)