pymdown-extensions の API リファレンス
pymdown-extensions (facelessuser/pymdown-extensions) の公開 API 308 件 —— クラス 103、関数 82、メソッド 123。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。
リポジトリ: facelessuser/pymdown-extensions
| 種別 | 件数 |
|---|---|
| クラス | 103 |
| 関数 | 82 |
| メソッド | 123 |
API 一覧
class
hatch_build.CustomMetadataHookOur metadata hook.
class
pymdownx.__meta__.VersionGet the version (PEP 440).
func
pymdownx.__meta__.parse_version(ver:str) -> VersionParse version into a comparable Version tuple.
class
pymdownx._bypassnorm.BypassNormExtensionBypass whitespace normalization.
class
pymdownx._bypassnorm.PostNormalizePreprocessorPreprocessor to clean up normalization bypass hack.
class
pymdownx._bypassnorm.PreNormalizePreprocessorPreprocessor to remove workaround symbols.
func
pymdownx._bypassnorm.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.arithmatex.ArithmatexExtensionAdds delete extension to Markdown class.
class
pymdownx.arithmatex.BlockArithmatexProcessorMathJax block processor to find $$MathJax$$ content.
method
pymdownx.arithmatex.BlockArithmatexProcessor.generic_output(parent, math)Generic output.
method
pymdownx.arithmatex.BlockArithmatexProcessor.mathjax_output(parent, math)Default MathJax output.
class
pymdownx.arithmatex.InlineArithmatexPatternArithmatex inline pattern handler.
func
pymdownx.arithmatex.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.b64.B64ExtensionB64 extension.
class
pymdownx.b64.B64PostprocessorPost processor for B64.
func
pymdownx.b64.makeExtension(*args, **kwargs)Return extension.
func
pymdownx.b64.repl(m, base_path, root_path, restrict_path=True)Replace.
func
pymdownx.b64.repl_path(m, base_path, root_path, restrict_path=True)Replace path with b64 encoded data.
class
pymdownx.betterem.AsteriskProcessorEmphasis processor for handling strong and em matches.
class
pymdownx.betterem.BetterEmExtensionAdd extension to Markdown class.
method
pymdownx.betterem.BetterEmExtension.extendMarkdown(md)Modify inline patterns.
method
pymdownx.betterem.BetterEmExtension.make_better(md)Configure all the pattern rules.
class
pymdownx.betterem.SmartAsteriskProcessorSmart emphasis and strong processor.
class
pymdownx.betterem.SmartUnderscoreProcessorEmphasis processor for handling strong and em matches.
class
pymdownx.betterem.UnderscoreProcessorEmphasis processor for handling strong and em matches.
func
pymdownx.betterem.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.blocks.BlockEntryTrack Block entries.
class
pymdownx.blocks.BlocksExtensionBlocks Extension.
method
pymdownx.blocks.BlocksExtension.extendMarkdown(md:Markdown) -> NoneExtend markdown.
method
pymdownx.blocks.BlocksExtension.extendMarkdownBlocks(md:Markdown, block_mgr:BlocksProcessor) -> NoneExtend Markdown blocks.
method
pymdownx.blocks.BlocksExtension.register_block_mgr(md:Markdown) -> BlocksProcessorAdd Blocks to Markdown instance.
class
pymdownx.blocks.BlocksMgrExtensionAdd generic Blocks extension.
method
pymdownx.blocks.BlocksMgrExtension.extendMarkdown(md:Markdown) -> NoneAdd Blocks to Markdown instance.
method
pymdownx.blocks.BlocksMgrExtension.reset() -> NoneReset.
class
pymdownx.blocks.BlocksProcessorGeneric block processor.
method
pymdownx.blocks.BlocksProcessor.capture_leaked_content(parent:etree.Element, entry:BlockEntry) -> NoneCapture leaked content.
method
pymdownx.blocks.BlocksProcessor.detab_by_length(text:str, length:int) -> tuple[str, str]Remove a tab from the front of each line of the given text.
method
pymdownx.blocks.BlocksProcessor.get_parent(parent:etree.Element) -> etree.Element | NoneGet parent.
method
pymdownx.blocks.BlocksProcessor.is_block(tag:etree.Element) -> boolIs tag block.
method
pymdownx.blocks.BlocksProcessor.is_raw(tag:etree.Element) -> boolIs tag raw.
method
pymdownx.blocks.BlocksProcessor.parse_blocks(blocks:list[str], current_parent:etree.Element) -> NoneParse the blocks.
method
pymdownx.blocks.BlocksProcessor.register(b:type[Block], config:dict[str, Any]) -> NoneRegister a block.
method
pymdownx.blocks.BlocksProcessor.run(parent:etree.Element, blocks:list[str]) -> NoneConvert to details/summary block.
method
pymdownx.blocks.BlocksProcessor.split_header(block:str, length:int) -> tuple[dict[str, Any] | None, str]Split, YAML-ish header out.
method
pymdownx.blocks.BlocksProcessor.test(parent:etree.Element, block:str) -> boolTest to see if we should process the block.
class
pymdownx.blocks.BlocksTreeprocessorBlocks tree processor.
method
pymdownx.blocks.BlocksTreeprocessor.run(root:etree.Element) -> NoneUpdate tab IDs.
class
pymdownx.blocks.admonition.AdmonitionAdmonition.
method
pymdownx.blocks.admonition.Admonition.on_create(parent)Create the element.
method
pymdownx.blocks.admonition.Admonition.on_validate(parent)Handle on validate event.
class
pymdownx.blocks.admonition.AdmonitionExtensionAdmonition Blocks Extension.
func
pymdownx.blocks.admonition.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.blocks.block.BlockBlock.
method
pymdownx.blocks.block.Block.dedent(text:str, length:int | None=None) -> strDedent raw text.
method
pymdownx.blocks.block.Block.html_escape(text:str) -> strBasic html escaping.
method
pymdownx.blocks.block.Block.is_block(tag:etree.Element) -> boolIs block element.
method
pymdownx.blocks.block.Block.is_raw(tag:etree.Element) -> boolIs raw element.
method
pymdownx.blocks.block.Block.on_create(parent:etree.Element) -> etree.ElementCreate the needed element and return it.
method
pymdownx.blocks.block.Block.on_end(block:etree.Element) -> NonePerform any action on end.
method
pymdownx.blocks.block.Block.on_init() -> NoneOn initialize.
method
pymdownx.blocks.block.Block.on_inline_end(block:etree.Element) -> NonePerform action on the block after inline parsing.
method
pymdownx.blocks.block.Block.on_validate(parent:etree.Element) -> boolHandle validation event.
func
pymdownx.blocks.block.type_any(value:_T) -> _TAccepts any type.
func
pymdownx.blocks.block.type_boolean(value:Any) -> boolEnsure type boolean or fail.
func
pymdownx.blocks.block.type_html_attribute_dict(value:Any) -> dict[str, str | list[str]]Attribute dictionary.
func
pymdownx.blocks.block.type_html_identifier(value:Any) -> strEnsure type HTML attribute name or fail.
func
pymdownx.blocks.block.type_integer(value:Any) -> intEnsure type integer or fail.
func
pymdownx.blocks.block.type_multi(*args:Callable[[Any], _T]) -> Callable[[Any], _T]Validate a type with multiple type functions.
func
pymdownx.blocks.block.type_none(value:Any) -> NoneEnsure type None or fail.
func
pymdownx.blocks.block.type_number(value:Any) -> int | floatEnsure type number or fail.
func
pymdownx.blocks.block.type_ranged_integer(minimum:int | None=None, maximum:int | None=None) -> Callable[[Any], int | float]Ensured type integer is within range.
func
pymdownx.blocks.block.type_ranged_number(minimum:int | None=None, maximum:int | None=None) -> Callable[[Any], int | float]Ensure typed number is within range.
func
pymdownx.blocks.block.type_string(value:Any) -> strEnsure type string or fail.
func
pymdownx.blocks.block.type_string_delimiter(split:str, string_type:Callable[[Any], str]=type_string) -> Callable[[Any], list[str]]String delimiter function.
func
pymdownx.blocks.block.type_string_in(accepted:Iterable[str], insensitive:bool=True) -> Callable[[Any], str]Ensure type string is within the accepted list.
func
pymdownx.blocks.block.type_string_insensitive(value:Any) -> strEnsure type string and normalize case.
class
pymdownx.blocks.caption.CaptionFigure captions.
method
pymdownx.blocks.caption.Caption.on_create(parent)Create the element.
method
pymdownx.blocks.caption.Caption.on_init()Initialize.
method
pymdownx.blocks.caption.Caption.on_validate(parent)Handle on validate event.
class
pymdownx.blocks.caption.CaptionExtensionCaption Extension.
class
pymdownx.blocks.caption.CaptionTreeprocessorCaption tree processor.
func
pymdownx.blocks.caption.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.blocks.definition.DefinitionDefinition.
method
pymdownx.blocks.definition.Definition.on_create(parent)Create the element.
class
pymdownx.blocks.definition.DefinitionExtensionDefinition Blocks Extension.
func
pymdownx.blocks.definition.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.blocks.details.DetailsDetails.
method
pymdownx.blocks.details.Details.on_create(parent)Create the element.
method
pymdownx.blocks.details.Details.on_validate(parent)Handle on validate event.
class
pymdownx.blocks.details.DetailsExtensionAdmonition Blocks Extension.
func
pymdownx.blocks.details.makeExtension(*args, **kwargs)Return extension.
func
pymdownx.blocks.get_frontmatter(string:str) -> dict[str, Any] | NoneGet frontmatter from string.
class
pymdownx.blocks.html.HTMLHTML.
method
pymdownx.blocks.html.HTML.on_create(parent)Create the element.
method
pymdownx.blocks.html.HTML.on_end(block)On end event.
method
pymdownx.blocks.html.HTML.on_markdown()Check if this is atomic.
method
pymdownx.blocks.html.HTML.on_validate(parent)Handle argument parsing.
class
pymdownx.blocks.html.HTMLExtensionHTML Blocks Extension.
method
pymdownx.blocks.html.HTMLExtension.extendMarkdownBlocks(md, block_mgr)Extend Markdown blocks.
func
pymdownx.blocks.html.makeExtension(*args, **kwargs)Return extension.
func
pymdownx.blocks.html.parse_selectors(selector, require_tag=True)Parse the selector.
func
pymdownx.blocks.reindent(text:str, pos:int, level:int) -> list[str]Reindent the code to where it is supposed to be.
class
pymdownx.blocks.tab.TabTabbed container.
method
pymdownx.blocks.tab.Tab.on_add(block)Adjust where the content is added.
method
pymdownx.blocks.tab.Tab.on_create(parent)Create the element.
method
pymdownx.blocks.tab.Tab.on_init()Handle initialization.
class
pymdownx.blocks.tab.TabExtensionAdmonition Blocks Extension.
method
pymdownx.blocks.tab.TabExtension.extendMarkdownBlocks(md, block_mgr)Extend Markdown blocks.
class
pymdownx.blocks.tab.TabbedTreeprocessorTab tree processor.
method
pymdownx.blocks.tab.TabbedTreeprocessor.run(doc)Update tab IDs.
func
pymdownx.blocks.tab.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.caret.CaretInsertProcessorJust insert processor.
class
pymdownx.caret.CaretSmartInsertProcessorJust smart insert processor.
class
pymdownx.caret.CaretSmartProcessorSmart insert and sup processor.
class
pymdownx.caret.CaretSupProcessorJust superscript processor.
class
pymdownx.caret.InsertSupExtensionAdd insert and/or superscript extension to Markdown class.
func
pymdownx.caret.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.critic.CriticExtensionCritic extension.
method
pymdownx.critic.CriticExtension.extendMarkdown(md)Register the extension.
method
pymdownx.critic.CriticExtension.reset()Clear stash.
class
pymdownx.critic.CriticStashStash critic marks until ready.
method
pymdownx.critic.CriticStash.clear()Clear the stash.
method
pymdownx.critic.CriticStash.get(key, default=None)Get the specified item from the stash.
method
pymdownx.critic.CriticStash.remove(key)Remove the specified item from the stash.
method
pymdownx.critic.CriticStash.store(code)Store the code in the stash with the placeholder.
class
pymdownx.critic.CriticViewPreprocessorHandle viewing critic marks in Markdown content.
method
pymdownx.critic.CriticViewPreprocessor.critic_parse(m)Normal critic parser.
method
pymdownx.critic.CriticViewPreprocessor.html_escape(txt, strip_nl=False)Basic html escaping.
method
pymdownx.critic.CriticViewPreprocessor.run(lines)Process critic marks.
class
pymdownx.critic.CriticsPostprocessorHandle cleanup on post process for viewing critic marks.
method
pymdownx.critic.CriticsPostprocessor.block_edit(m)Handle block edits.
method
pymdownx.critic.CriticsPostprocessor.run(text)Replace critic placeholders.
func
pymdownx.critic.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.details.DetailsExtensionAdd Details extension.
class
pymdownx.details.DetailsProcessorDetails block processor.
method
pymdownx.details.DetailsProcessor.parse_content(parent, block)Get sibling details.
method
pymdownx.details.DetailsProcessor.test(parent, block)Test block.
func
pymdownx.details.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.emoji.EmojiAlertPostprocessorPost processor to strip out unwanted content.
class
pymdownx.emoji.EmojiExtensionAdd emoji extension to Markdown class.
method
pymdownx.emoji.EmojiExtension.extendMarkdown(md)Add support for emoji.
method
pymdownx.emoji.EmojiExtension.reset()Reset.
func
pymdownx.emoji.emojione(options, md)The EmojiOne index.
func
pymdownx.emoji.gemoji(options, md)The Gemoji index.
func
pymdownx.emoji.makeExtension(*args, **kwargs)Return extension.
func
pymdownx.emoji.to_alt(index, shortname, alias, uc, alt, title, category, options, md)Return html entities.
func
pymdownx.emoji.to_png(index, shortname, alias, uc, alt, title, category, options, md)Return PNG element.
func
pymdownx.emoji.to_svg(index, shortname, alias, uc, alt, title, category, options, md)Return SVG element.
func
pymdownx.emoji.twemoji(options, md)The Twemoji index.
class
pymdownx.escapeall.EscapeAllExtensionExtension that allows you to escape everything.
method
pymdownx.escapeall.EscapeAllExtension.extendMarkdown(md)Escape all.
class
pymdownx.escapeall.EscapeAllPatternReturn an escaped character.
func
pymdownx.escapeall.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.extra.ExtraExtensionAdd various extensions to Markdown class.
method
pymdownx.extra.ExtraExtension.extendMarkdown(md)Register extension instances.
func
pymdownx.extra.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.fancylists.FancyListBlockCollapse code.
method
pymdownx.fancylists.FancyListBlock.on_create(parent)Create the element.
method
pymdownx.fancylists.FancyListBlock.on_end(block)On end.
method
pymdownx.fancylists.FancyListBlock.on_init()Handle initialization.
method
pymdownx.fancylists.FancyListBlock.on_validate(parent)Handle on validate event.
class
pymdownx.fancylists.FancyListExtensionHTML Blocks Extension.
class
pymdownx.fancylists.FancyListTreeprocessorClean up fancy list metadata.
class
pymdownx.fancylists.FancyOListProcessorProcess fancy ordered list blocks.
method
pymdownx.fancylists.FancyOListProcessor.run(parent, blocks)Process list items.
class
pymdownx.fancylists.FancyUListProcessorProcess unordered list blocks.
func
pymdownx.fancylists.makeExtension(*args, **kwargs)Return extension.
func
pymdownx.fancylists.roman2int(s)Convert Roman numeral to integer.
class
pymdownx.highlight.BlockHtmlFormatterAdds ability to output line numbers in a new way.
method
pymdownx.highlight.BlockHtmlFormatter.wrap(source)Wrap the source code.
class
pymdownx.highlight.HighlightHighlight class.
method
pymdownx.highlight.Highlight.escape(txt)Basic HTML escaping.
method
pymdownx.highlight.Highlight.get_extended_language(language)Get extended language.
method
pymdownx.highlight.Highlight.get_lexer(src, language, inline, stripnl)Get the Pygments lexer.
class
pymdownx.highlight.HighlightExtensionConfigure highlight settings globally.
method
pymdownx.highlight.HighlightExtension.get_pymdownx_highlighter()Get the highlighter.
method
pymdownx.highlight.HighlightExtension.reset()Reset.
class
pymdownx.highlight.HighlightTreeprocessorHighlight source code in code blocks.
method
pymdownx.highlight.HighlightTreeprocessor.code_unescape(text)Unescape code.
class
pymdownx.highlight.InlineHtmlFormatterFormat the code blocks.
method
pymdownx.highlight.InlineHtmlFormatter.wrap(source)Overload wrap.
func
pymdownx.highlight.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.inlinehilite.InlineHiliteExceptionInlineHilite exception.
class
pymdownx.inlinehilite.InlineHiliteExtensionAdd inline highlighting extension to Markdown class.
class
pymdownx.inlinehilite.InlineHilitePatternHandle the inline code patterns.
method
pymdownx.inlinehilite.InlineHilitePattern.handleMatch(m, data)Handle the pattern match.
method
pymdownx.inlinehilite.InlineHilitePattern.handle_code(lang, src)Handle code block.
func
pymdownx.inlinehilite.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.keys.KeysExtensionAdd `keys`` extension to Markdown class.
method
pymdownx.keys.KeysExtension.extendMarkdown(md)Add support for keys.
class
pymdownx.keys.KeysPatternReturn kbd tag.
method
pymdownx.keys.KeysPattern.handleMatch(m, data)Handle kbd pattern matches.
method
pymdownx.keys.KeysPattern.normalize(key)Normalize the value.
method
pymdownx.keys.KeysPattern.process_key(key)Process key.
func
pymdownx.keys.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.magiclink.MagiclinkInternalRefsPatternConvert #1, !1, and commit_hash.
class
pymdownx.magiclink.MagiclinkMailPatternConvert emails to clickable email links.
method
pymdownx.magiclink.MagiclinkMailPattern.handleMatch(m, data)Handle email link patterns.
class
pymdownx.magiclink.MagiclinkMentionPatternConvert @mention to links.
class
pymdownx.magiclink.MagiclinkPatternConvert html, ftp links to clickable links.
method
pymdownx.magiclink.MagiclinkPattern.handleMatch(m, data)Handle URL matches.
class
pymdownx.magiclink.MagiclinkRepositoryPatternConvert @user/repo to links.
func
pymdownx.magiclink.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.mark.MarkExtensionAdd the mark extension to Markdown class.
class
pymdownx.mark.MarkProcessorHandle mark patterns.
class
pymdownx.mark.MarkSmartProcessorHandle smart mark patterns.
func
pymdownx.mark.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.pathconverter.PathConverterExtensionPathConverter extension.
class
pymdownx.pathconverter.PathConverterPostprocessorPost process to find tag lings to convert.
method
pymdownx.pathconverter.PathConverterPostprocessor.run(text)Find and convert paths.
func
pymdownx.pathconverter.makeExtension(*args, **kwargs)Return extension.
func
pymdownx.pathconverter.repl(m, base_path, rel_path=None, file_scheme=None)Replace.
class
pymdownx.progressbar.ProgressBarExtensionAdd progress bar extension to Markdown class.
class
pymdownx.progressbar.ProgressBarPatternPattern handler for the progress bars.
method
pymdownx.progressbar.ProgressBarPattern.create_tag(width, label, add_classes, alist)Create the tag.
method
pymdownx.progressbar.ProgressBarPattern.handleMatch(m, data)Handle the match.
class
pymdownx.progressbar.ProgressBarTreeProcessorUsed for AttrList compatibility.
func
pymdownx.progressbar.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.quotes.QuotesExtensionAdd blockquotes extension to Markdown class.
method
pymdownx.quotes.QuotesExtension.extendMarkdown(md:Markdown) -> NoneAdd support for blockquotes.
class
pymdownx.quotes.QuotesProcessorProcess blockquotes.
method
pymdownx.quotes.QuotesProcessor.clean(line:str) -> strRemove `>` from beginning of a line.
method
pymdownx.quotes.QuotesProcessor.run(parent:etree.Element, blocks:list[str]) -> NoneCreate blockquote.
method
pymdownx.quotes.QuotesProcessor.test(parent:etree.Element, block:str) -> boolTest for block quote.
func
pymdownx.quotes.makeExtension(*args:Any, **kwargs:Any) -> ExtensionReturn extension.
class
pymdownx.saneheaders.SaneHeadersExtensionAdds the sane headers extension.
class
pymdownx.saneheaders.SaneHeadersProcessorProcess hash headers syntax.
func
pymdownx.saneheaders.makeExtension(*args, **kwargs)Return extension.
func
pymdownx.slugs.lower(m)Lowercase character.
func
pymdownx.slugs.slugify(**kwargs)Configurable slugify.
func
pymdownx.slugs.uslugify(text, sep)Unicode slugify.
func
pymdownx.slugs.uslugify_encoded(text, sep)Unicode slugify (percent encoded).
class
pymdownx.smartsymbols.SmartSymbolsExtensionSmart Symbols extension.
class
pymdownx.smartsymbols.SmartSymbolsPatternSmart symbols patterns handler.
method
pymdownx.smartsymbols.SmartSymbolsPattern.handleMatch(m, data)Replace symbol.
func
pymdownx.smartsymbols.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.snippets.SnippetExtensionSnippet extension.
method
pymdownx.snippets.SnippetExtension.extendMarkdown(md)Register the extension.
method
pymdownx.snippets.SnippetExtension.reset()Reset.
class
pymdownx.snippets.SnippetMissingErrorSnippet missing exception.
class
pymdownx.snippets.SnippetPreprocessorHandle snippets in Markdown content.
method
pymdownx.snippets.SnippetPreprocessor.dedent(lines)De-indent lines.
method
pymdownx.snippets.SnippetPreprocessor.get_snippet_path(path)Get snippet path.
method
pymdownx.snippets.SnippetPreprocessor.run(lines)Process snippets.
func
pymdownx.snippets.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.striphtml.StripHtmlExtensionStripHTML extension.
class
pymdownx.striphtml.StripHtmlPostprocessorPost processor to strip out unwanted content.
func
pymdownx.striphtml.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.superfences.CodeStashStash code for later retrieval.
method
pymdownx.superfences.CodeStash.clear_stash()Clear the stash.
method
pymdownx.superfences.CodeStash.get(key, default=None)Get the code from the key.
method
pymdownx.superfences.CodeStash.remove(key)Remove the stashed code.
method
pymdownx.superfences.CodeStash.store(key, code, indent_level)Store the code in the stash.
class
pymdownx.superfences.SuperFencesBlockPreprocessorPreprocessor to find fenced code blocks.
method
pymdownx.superfences.SuperFencesBlockPreprocessor.clear()Reset the class variables.
method
pymdownx.superfences.SuperFencesBlockPreprocessor.handle_attrs(m)Handle attribute list.
method
pymdownx.superfences.SuperFencesBlockPreprocessor.normalize_ws(text)Normalize whitespace.
method
pymdownx.superfences.SuperFencesBlockPreprocessor.parse_fence_line(line)Parse fence line.
method
pymdownx.superfences.SuperFencesBlockPreprocessor.parse_line_special(linespecial)Parse line start.
method
pymdownx.superfences.SuperFencesBlockPreprocessor.parse_line_start(linestart)Parse line start.
method
pymdownx.superfences.SuperFencesBlockPreprocessor.parse_line_step(linestep)Parse line start.
method
pymdownx.superfences.SuperFencesBlockPreprocessor.parse_options(m)Get options.
method
pymdownx.superfences.SuperFencesBlockPreprocessor.reassemble(lines)Reassemble text.
method
pymdownx.superfences.SuperFencesBlockPreprocessor.run(lines)Search for fenced blocks.
class
pymdownx.superfences.SuperFencesCodeExtensionSuperFences code block extension.
method
pymdownx.superfences.SuperFencesCodeExtension.reset()Clear the stash.
func
pymdownx.superfences.default_validator(language, inputs, options, attrs, md)Default validator.
func
pymdownx.superfences.fence_div_format(source, language, class_name, options, md, **kwargs)Format source as div.
func
pymdownx.superfences.highlight_validator(language, inputs, options, attrs, md)Highlight validator.
func
pymdownx.superfences.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.tabbed.TabbedExtensionAdd Tabbed extension.
method
pymdownx.tabbed.TabbedExtension.reset()Reset.
class
pymdownx.tabbed.TabbedProcessorTabbed block processor.
method
pymdownx.tabbed.TabbedProcessor.parse_content(parent, block)Get sibling tab.
method
pymdownx.tabbed.TabbedProcessor.run(parent, blocks)Convert to tabbed block.
method
pymdownx.tabbed.TabbedProcessor.test(parent, block)Test block.
class
pymdownx.tabbed.TabbedTreeprocessorTab tree processor.
method
pymdownx.tabbed.TabbedTreeprocessor.run(doc)Update tab IDs.
func
pymdownx.tabbed.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.tasklist.TasklistExtensionTasklist extension.
func
pymdownx.tasklist.get_checkbox(state, custom_checkbox=False, clickable_checkbox=False)Get checkbox tag.
func
pymdownx.tasklist.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.tilde.DeleteSubExtensionAdd delete and/or subscript extension to Markdown class.
class
pymdownx.tilde.TildeDeleteProcessorJust delete processor.
class
pymdownx.tilde.TildeSmartDeleteProcessorJust smart delete processor.
class
pymdownx.tilde.TildeSmartProcessorSmart delete and subscript processor.
class
pymdownx.tilde.TildeSubProcessorJust subscript processor.
func
pymdownx.tilde.makeExtension(*args, **kwargs)Return extension.
class
pymdownx.util.PatSeqItemPattern sequence item item.
method
pymdownx.util.PatternSequenceProcessor.build_double(m:re.Match[str], tags:str, full_recursion:bool, idx:int) -> etree.ElementReturn double tag.
method
pymdownx.util.PatternSequenceProcessor.build_element(m:re.Match[str], builder:str, tags:str, full_recursion:bool, index:int) -> etree.ElementElement builder.
method
pymdownx.util.PatternSequenceProcessor.build_single(m:re.Match[str], tag:str, full_recursion:bool, idx:int) -> etree.ElementReturn single tag.
method
pymdownx.util.PatternSequenceProcessor.handleMatch(m:re.Match[str], data:str) -> tuple[etree.Element | None, int | None, int | None]Parse patterns.
method
pymdownx.util.PatternSequenceProcessor.parse_sub_patterns(data:str, parent:etree.Element, last:None | etree.Element, full_recursion:bool, idx:int) -> NoneParses sub patterns.
func
pymdownx.util.clamp(value:float, mn:float, mx:float) -> floatClamp the value to the given minimum and maximum.
func
pymdownx.util.escape_chars(md:Markdown, echrs:Sequence[str]) -> NoneAdd chars to the escape list.
func
pymdownx.util.get_char(value:int) -> strGet the Unicode char.
func
pymdownx.util.get_code_points(s:str) -> list[str]Get the Unicode code points.
func
pymdownx.util.get_ord(c:str) -> intGet Unicode ord.
func
pymdownx.util.is_linux() -> boolIs Linux.
func
pymdownx.util.is_mac() -> boolIs macOS.
func
pymdownx.util.is_win() -> boolIs Windows.
func
pymdownx.util.parse_url(url:str) -> tuple[str, str, str, str, str, str, bool, bool]Parse the URL.
func
pymdownx.util.path2url(url:str) -> strURL to path.
func
pymdownx.util.url2path(path:str) -> strPath to URL.
func
pymdownx.util.warn_deprecated(message:str, stacklevel:int=2) -> NoneWarn deprecated.
func
run_tests.main()Main function.
この情報について
掲載しているシグネチャは facelessuser/pymdown-extensions の公開ソースコードを
Python の ast モジュールで静的解析し、引数名・デフォルト値・
型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。
詳しくは仕組みの解説をご覧ください。