Skip to content

mkdocs_nype.plugins.custom_blog_categorization.config

CustomBlogCategorizationConfig

Bases: Config

enabled

enabled = Type(bool, default=True)

hook_blog_dir

hook_blog_dir = Type(str)

render_name

render_name = Type(str)

code_name

code_name = Type(str)

url_format

url_format = Type(str)

slugify

slugify = Type(Callable, default=slugify(case='lower'))

slugify_separator

slugify_separator = Type(str, default='-')

allowed_values

allowed_values = Type(list, default=[])

toc

toc = Optional(Type(bool))

view_generator

view_generator = Type(Callable, default=get_custom_view)

post_excerpt_max

post_excerpt_max = Type(int, default=5)

icon

icon = Type(str, default='material/briefcase')

singular_name

singular_name = Optional(Type(str))

get_custom_view

get_custom_view() -> View