mkdocs_nype.plugins.only_blog_nav.plugin

Synopsis

MkDocs plugin made to hide non-blog navigation entries when displaying a blog.

This plugin was formerly a hook:

MIT License Kamil Krzyśków (HRY) for Nype (npe.cm) and Fiori Tracker (fioritracker.org)

PLUGIN_NAME: str = 'only_blog_nav'

Name of the plugin

LOG: PrefixedLogger = PrefixedLogger(PLUGIN_NAME, getLogger(f'mkdocs.plugins.{PLUGIN_NAME}'))

Logger instance for this plugin.

MultiBlogAwareness()

blog_prefixes = None

Each blog should register their prefix, cleared in on_config, filled in on_page_context

OnlyBlogNavPlugin()

Bases: BasePlugin[OnlyBlogNavConfig]

supports_multiple_instances = True

non_blog_entries = []

blog_entries = []

_all_entries_ref = None

blog_parent = None

is_nav_expand_enabled = False

on_config(config: MkDocsConfig) -> MkDocsConfig | None

on_nav(nav: Navigation, /, *, config: MkDocsConfig, files: Files) -> Navigation | None

Run after blog plugin (-50). Gather 2 lists of nav entires that are inside and outside of the blog.

on_env(env: Environment, /, *, config: MkDocsConfig, files: Files) -> Environment | None

on_page_context(context: TemplateContext, /, *, page: Page, config: MkDocsConfig, nav: Navigation) -> TemplateContext | None

Repalce the nav for pages in the blog