mkdocs_nype.plugins.latest_blog_posts.plugin

Synopsis

MkDocs plugin made to insert latest blog posts on a page.

This plugin was formerly a hook:

Note

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

PLUGIN_NAME: str = 'latest_blog_posts'

Name of the plugin

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

Logger instance for this plugin.

BLOG_INSTANCE_MAP: dict[str, BlogPlugin] = {}

Mapping of active blog instances. Set in on_config

REQUIRED_OPTIONS: list[str] = ['root', 'amount', 'title', 'read_more']

List of lowercase required options to validate the input

HTML_SIMPLE_TEMPLATE: str = strip()

MARKDOWN_GRID_TEMPLATE: str = lstrip()

HTML_GRID_TEMPLATE: str = strip()

CSS_TEMLATE: str = strip()

JS_TEMPLATE: str = strip()

LatestBlogPostsPlugin()

exec_count = None

on_config(config: MkDocsConfig)

on_page_markdown(markdown: str, page: Page, config: MkDocsConfig, files)

insert_latest_posts(line, config: MkDocsConfig)

render_html_grid_li(post, strftime)