Skip to content

plugin ¤

Configuration options for the MkDocs Manpage plugin.

Classes:

PygmentsConfig ¤

Bases: Config

Configuration options for the plugin.

PygmentsPlugin ¤

PygmentsPlugin()

Bases: BasePlugin[PygmentsConfig]

The MkDocs plugin to inject Pygments style sheets.

Methods:

  • on_config –

    Inject dark and light style sheets in extra_css.

  • on_post_build –

    Write the CSS contents to the injected style sheets.

on_config ¤

on_config(config: MkDocsConfig) -> MkDocsConfig | None

Inject dark and light style sheets in extra_css.

Parameters:

  • config (MkDocsConfig) –

    The MkDocs config object.

Returns:

  • MkDocsConfig | None –

    The config.

on_post_build ¤

on_post_build(config: MkDocsConfig, **kwargs: Any) -> None

Write the CSS contents to the injected style sheets.

Parameters:

  • config (MkDocsConfig) –

    MkDocs configuration.