mkdocs_nype

Synopsis

MkDocs Nype theme, based on the Material for MkDocs theme.

This __init__.py file gets loaded by MkDocs before plugins are initialized. Therefore, this is a good place to monkey-patch changes into the build process.

Consider both nype/ and material/ namespaces when loading plugins

Due to how themename/pluginname namespaces work to make using Nype projects more convenient we change the logic of how namespaces are resolved. pluginname will be resolved in order:

1. nype/pluginname
2. material/pluginname
3. pluginname

Inject predefined plugins for loading even when they're not in mkdocs.yml

Instead of requiring to enable a plugin in a project mkdocs.yml, enable it by default. This allows nype_tweaks to operate as a project manager for the entirety of the event loop.

Extend Material theme plugins directly

Instead of configuring other plugins and overriding internals of mkdocs-material plugins during the event loop, extend them before they're loaded into "Python MkDocs memory". This allows to directly modify how the PluginConfig is resolved, therefore allows to add options directly under the extended plugin in mkdocs.yml instead of under another plugin.

MIT License 2024 Kamil Krzyśków (HRY) for Nype (npe.cm)

LOG: PrefixedLogger = PrefixedLogger('mkdocs_nype', getLogger(f'mkdocs.themes.mkdocs_nype'))

issue_counter = CountHandler()

WANTED_PLUGINS: tuple[PluginEntry] = (PluginEntry('nype_tweaks', scope='nype'), PluginEntry('minify_html', config={'enabled': _parse_env_flag(), 'keep_html_and_head_opening_tags': True, 'keep_closing_tags': True}), PluginEntry('webp_images', scope='nype', config={'enabled': _parse_env_flag(), 'ignore_paths': dedent(strip())}))

PluginEntry(name: str, scope: str = None, config: dict = None)

name: str

scope: str = None

config: dict = None

patch_plugin_loading()

load_plugin_with_namespace(self, name: str, config)

patch_default_plugins_auto_load()

run_validation(self, value: object) -> mkdocs.plugins.PluginCollection

_get_checksum(source: str) -> str

_parse_env_flag(varname: str = 'CI', default: bool = False) -> bool