mkdocs_rss_plugin.plugin module

class mkdocs_rss_plugin.plugin.GitRssPlugin[source]

Bases: mkdocs.plugins.BasePlugin

config_scheme = (('abstract_chars_count', <mkdocs.config.config_options.Type object>), ('category', <mkdocs.config.config_options.Type object>), ('date_from_meta', <mkdocs.config.config_options.Type object>), ('feed_ttl', <mkdocs.config.config_options.Type object>), ('image', <mkdocs.config.config_options.Type object>), ('length', <mkdocs.config.config_options.Type object>), ('pretty_print', <mkdocs.config.config_options.Type object>))
on_config(config)[source]

The config event is the first event called on build and is run immediately after the user configuration is loaded and validated. Any alterations to the config should be made here. https://www.mkdocs.org/user-guide/plugins/#on_config

Args:

config (dict): global configuration object

Returns:

dict: global configuration object

Return type

dict

on_page_markdown(markdown, page, config, files)[source]

The page_markdown event is called after the page’s markdown is loaded from file and can be used to alter the Markdown source text. The meta- data has been stripped off and is available as page.meta at this point.

https://www.mkdocs.org/user-guide/plugins/#on_page_markdown

Args:

markdown (str): Markdown source text of page as string page: mkdocs.nav.Page instance config: global configuration object site_navigation: global navigation object

Returns:

str: Markdown source text of page as string

Return type

str

on_post_build(config)[source]

The post_build event does not alter any variables. Use this event to call post-build scripts. See: <https://www.mkdocs.org/user-guide/plugins/#on_post_build>

Args:

config (dict): global configuration object

Returns:

dict: global configuration object

Return type

dict