Skip to main content

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 (^^text^^)
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_strikethrough
Check if a line contains strikethrough syntax (text)
contains_subscript
Check if a line contains subscript syntax (text not inside strike)
contains_superscript
Check if a line contains superscript syntax (^text^ not inside ^^insert^^)
find_insert_spans
Find all insert (^^text^^) spans
find_keyboard_shortcuts
Find all keyboard shortcuts in a line
find_keys_spans
Find all keyboard shortcut spans
find_mark_spans
Find all mark (==text==) spans
find_smart_symbol_spans
Find all SmartSymbol spans
find_strikethrough_spans
Find all strikethrough (text) spans
find_subscript_spans
Find all subscript (text) spans, excluding those inside strikethrough spans
find_superscript_spans
Find all superscript (^text^) spans, excluding those inside insert spans
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
is_in_tilde_markup
Check if a position is within subscript or strikethrough markup
is_inline_hilite_content
Check if code span content starts with InlineHilite shebang
mask_pymdown_markup
Mask all PyMdown extension markup with spaces (single-pass)