sdkagent

mkdocs-material API reference

72 public APIs from mkdocs-material (squidfunk/mkdocs-material) — 32 classes, 6 functions, 34 methods. Signatures extracted by static analysis of the actual source.

Repository: squidfunk/mkdocs-material

KindCount
Classes32
Functions6
Methods34

API list

methodmaterial.extensions.preview.PreviewExtension.extendMarkdown(md:Markdown)
Register Markdown extension.
methodmaterial.extensions.preview.PreviewProcessor.run(root:Element)
Run the treeprocessor.
funcmaterial.extensions.preview.get_filter(settings:dict, key:str)
Get file filter from settings.
funcmaterial.extensions.preview.makeExtension(**kwargs)
Register Markdown extension.
classmaterial.plugins.tags.plugin.TagsPlugin
A tags plugin.
methodmaterial.plugins.tags.plugin.TagsPlugin.on_config(config:MkDocsConfig) -> None
Create mapping and listing managers.
methodmaterial.plugins.tags.plugin.TagsPlugin.on_env(env:Environment, *config:MkDocsConfig, **kwargs) -> None
Populate listings.
methodmaterial.plugins.tags.plugin.TagsPlugin.on_page_context(context:TemplateContext, *page:Page, **kwargs) -> None
Add tag references to page context.
methodmaterial.plugins.tags.plugin.TagsPlugin.on_page_markdown(markdown:str, *page:Page, *config:MkDocsConfig, **kwargs) -> str
Collect tags and listings from page.
methodmaterial.plugins.tags.plugin.TagsPlugin.on_startup(*command, **kwargs) -> None
Determine whether we're serving the site.
classmaterial.plugins.tags.renderer.Renderer
A renderer for tags and listings.
methodmaterial.plugins.tags.renderer.Renderer.render(page:Page, name:str, **kwargs) -> str
Render a template.
classmaterial.plugins.tags.structure.listing.Listing
A listing of tags.
methodmaterial.plugins.tags.structure.listing.Listing.add(mapping:Mapping, *hidden=True) -> None
Add mapping to listing.
classmaterial.plugins.tags.structure.listing.config.ListingConfig
A listing configuration.
classmaterial.plugins.tags.structure.listing.manager.ListingManager
A listing manager.
methodmaterial.plugins.tags.structure.listing.manager.ListingManager.add(page:Page, markdown:str) -> str
Add page.
methodmaterial.plugins.tags.structure.listing.manager.ListingManager.closest(mapping:Mapping) -> list[Listing]
Get listings for the mapping ordered by closeness.
funcmaterial.plugins.tags.structure.listing.manager.toc.find(listing:Listing) -> tuple[AnchorLink | None, int]
Find anchor link for the given listing.
classmaterial.plugins.tags.structure.listing.tree.ListingTree
A listing tree.
classmaterial.plugins.tags.structure.mapping.Mapping
A mapping between a page or link and a set of tags.
classmaterial.plugins.tags.structure.mapping.manager.MappingManager
A mapping manager.
methodmaterial.plugins.tags.structure.mapping.manager.MappingManager.add(page:Page, markdown:str) -> Mapping | None
Add page.
methodmaterial.plugins.tags.structure.mapping.manager.MappingManager.get(page:Page) -> Mapping | None
Get mapping for page, if any.
classmaterial.plugins.tags.structure.mapping.storage.MappingStorage
A mapping storage.
methodmaterial.plugins.tags.structure.mapping.storage.MappingStorage.load(path:str) -> Iterable[Mapping]
Load mappings from file.
methodmaterial.plugins.tags.structure.mapping.storage.MappingStorage.save(path:str, mappings:Iterable[Mapping]) -> None
Save mappings to file.
classmaterial.plugins.tags.structure.tag.Tag
A tag.
classmaterial.plugins.tags.structure.tag.options.TagSet
Setting for a set of tags.
methodmaterial.plugins.tags.structure.tag.options.TagSet.run_validation(value:object) -> set[Tag]
Validate list of tags.
classmaterial.plugins.tags.structure.tag.reference.TagReference
A tag reference.
methodmaterial.plugins.tags.structure.tag.reference.TagReference.url() -> str | None
Return the URL of the tag reference.
classmaterial.utilities.filter.FileFilter
A file filter.
classmaterial.utilities.filter.Filter
A filter.
classmaterial.utilities.filter.config.FilterConfig
A filter configuration.
classsrc.extensions.preview.PreviewExtension
A Markdown extension to enable instant previews on links.
methodsrc.extensions.preview.PreviewExtension.extendMarkdown(md:Markdown)
Register Markdown extension.
classsrc.extensions.preview.PreviewProcessor
A Markdown treeprocessor to enable instant previews on links.
methodsrc.extensions.preview.PreviewProcessor.run(root:Element)
Run the treeprocessor.
funcsrc.extensions.preview.get_filter(settings:dict, key:str)
Get file filter from settings.
funcsrc.extensions.preview.makeExtension(**kwargs)
Register Markdown extension.
classsrc.plugins.tags.plugin.TagsPlugin
A tags plugin.
methodsrc.plugins.tags.plugin.TagsPlugin.on_config(config:MkDocsConfig) -> None
Create mapping and listing managers.
methodsrc.plugins.tags.plugin.TagsPlugin.on_env(env:Environment, *config:MkDocsConfig, **kwargs) -> None
Populate listings.
methodsrc.plugins.tags.plugin.TagsPlugin.on_page_context(context:TemplateContext, *page:Page, **kwargs) -> None
Add tag references to page context.
methodsrc.plugins.tags.plugin.TagsPlugin.on_page_markdown(markdown:str, *page:Page, *config:MkDocsConfig, **kwargs) -> str
Collect tags and listings from page.
methodsrc.plugins.tags.plugin.TagsPlugin.on_startup(*command, **kwargs) -> None
Determine whether we're serving the site.
classsrc.plugins.tags.renderer.Renderer
A renderer for tags and listings.
methodsrc.plugins.tags.renderer.Renderer.render(page:Page, name:str, **kwargs) -> str
Render a template.
classsrc.plugins.tags.structure.listing.Listing
A listing of tags.
methodsrc.plugins.tags.structure.listing.Listing.add(mapping:Mapping, *hidden=True) -> None
Add mapping to listing.
classsrc.plugins.tags.structure.listing.config.ListingConfig
A listing configuration.
classsrc.plugins.tags.structure.listing.manager.ListingManager
A listing manager.
methodsrc.plugins.tags.structure.listing.manager.ListingManager.add(page:Page, markdown:str) -> str
Add page.
methodsrc.plugins.tags.structure.listing.manager.ListingManager.closest(mapping:Mapping) -> list[Listing]
Get listings for the mapping ordered by closeness.
funcsrc.plugins.tags.structure.listing.manager.toc.find(listing:Listing) -> tuple[AnchorLink | None, int]
Find anchor link for the given listing.
classsrc.plugins.tags.structure.listing.tree.ListingTree
A listing tree.
classsrc.plugins.tags.structure.mapping.Mapping
A mapping between a page or link and a set of tags.
classsrc.plugins.tags.structure.mapping.manager.MappingManager
A mapping manager.
methodsrc.plugins.tags.structure.mapping.manager.MappingManager.add(page:Page, markdown:str) -> Mapping | None
Add page.
methodsrc.plugins.tags.structure.mapping.manager.MappingManager.get(page:Page) -> Mapping | None
Get mapping for page, if any.
classsrc.plugins.tags.structure.mapping.storage.MappingStorage
A mapping storage.
methodsrc.plugins.tags.structure.mapping.storage.MappingStorage.load(path:str) -> Iterable[Mapping]
Load mappings from file.
methodsrc.plugins.tags.structure.mapping.storage.MappingStorage.save(path:str, mappings:Iterable[Mapping]) -> None
Save mappings to file.
classsrc.plugins.tags.structure.tag.Tag
A tag.
classsrc.plugins.tags.structure.tag.options.TagSet
Setting for a set of tags.
methodsrc.plugins.tags.structure.tag.options.TagSet.run_validation(value:object) -> set[Tag]
Validate list of tags.
classsrc.plugins.tags.structure.tag.reference.TagReference
A tag reference.
methodsrc.plugins.tags.structure.tag.reference.TagReference.url() -> str | None
Return the URL of the tag reference.
classsrc.utilities.filter.FileFilter
A file filter.
classsrc.utilities.filter.Filter
A filter.
classsrc.utilities.filter.config.FilterConfig
A filter configuration.

About this data

These signatures were extracted from the public source of squidfunk/mkdocs-material using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries