Skip to content

Plugin configuration

Info

Since MkNodes is building template HTMLs in the background, you need to set to the theme custom_dir to an existing folder. This folder must be placed outside of the docs/ dir.

indexing class-attribute instance-attribute 

indexing = Choice(('full', 'sections', 'titles'), default='full')

lang class-attribute instance-attribute 

lang = Optional(LangOption())

min_search_length class-attribute instance-attribute 

min_search_length = Type(int, default=3)

prebuild_index class-attribute instance-attribute 

prebuild_index = Choice((False, True, 'node', 'python'), default=False)

separator class-attribute instance-attribute 

separator = Type(str, default='[\\s\\-]+')
Page info
Code for this page
mkdocs_mknodes.manual.get_started_section._
27
28
29
30
31
32
33
34
35
36
37
38
@router.route_page("Plugin configuration", hide="toc")
def _(page: mk.MkPage):
    page += mk.MkTemplate("plugin_configuration.jinja")
    eps = page.ctx.metadata.entry_points.get_group("mkdocs.plugins")
    page += mk.MkDocStrings(
        eps[0].load().config_class,
        show_root_toc_entry=False,
        show_if_no_docstring=True,
        heading_level=4,
        show_bases=False,
        show_source=False,
    )
Resources 
Resources(css=[],
          markdown_extensions={'attr_list': {},
                               'md_in_html': {},
                               'pymdownx.emoji': {'emoji_generator': <function to_svg at 0x7f6e52627c40>,
                                                  'emoji_index': <function twemoji at 0x7f6e52627b00>},
                               'pymdownx.magiclink': {'repo': 'mkdocs_mknodes',
                                                      'repo_url_shorthand': True,
                                                      'user': 'phil65'}},
          plugins=[Plugin('mkdocstrings')],
          js=[],
          assets=[],
          packages=[])
Metadata 
created:
  source_filename: /home/runner/work/mkdocs-mknodes/mkdocs-mknodes/mkdocs_mknodes/manual/root.py
  source_function: Build.on_root
  source_line_no: 24
hide:
- toc
template: SUMMARY.html
title: Plugin configuration