plugin ¤
Configuration options for the MkDocs Manpage plugin.
Classes:
-
PygmentsConfig
–Configuration options for the plugin.
-
PygmentsPlugin
–The MkDocs plugin to inject Pygments style sheets.
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.
Source code in src/mkdocs_pygments/plugin.py
75 76 77 |
|
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.
Source code in src/mkdocs_pygments/plugin.py
79 80 81 82 83 84 85 86 87 88 89 90 |
|
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.
Source code in src/mkdocs_pygments/plugin.py
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 |
|