Module mkdocs_extensions

Module mkdocs_extensions 

Source

Structs§

KeyboardShortcut
Parsed keyboard shortcut

Constants§

COMMON_KEYS
Common keyboard key names for validation

Functions§

contains_inline_hilite
Check if a line contains InlineHilite syntax
contains_insert
Check if a line contains insert syntax
contains_keys
Check if a line contains keyboard key notation
contains_mark
Check if a line contains mark/highlight syntax
contains_smart_symbols
Check if a line contains potential SmartSymbol patterns
contains_superscript
Check if a line contains superscript syntax Returns true if there’s a single caret pattern that’s NOT part of ^^insert^^
find_keyboard_shortcuts
Find all keyboard shortcuts in a line
is_in_caret_markup
Check if a position is within superscript or insert markup
is_in_keys
Check if a position in a line is within a keyboard shortcut
is_in_mark
Check if a position is within mark markup
is_in_pymdown_markup
Check if a position is within any PyMdown extension markup
is_in_smart_symbol
Check if a position is at a SmartSymbol that will be replaced
is_inline_hilite_content
Check if code span content starts with InlineHilite shebang
mask_pymdown_markup
Mask all PyMdown extension markup with spaces