mkdocs_autorefs_plugin_crossreference_quickstart_example.py

1from mkdocs_autorefs.plugin import AutorefsPlugin
2from mkdocs_autorefs.references import fix_ref_links
3
4# Example of how mkdocs-autorefs processes a reference in Markdown
5markdown_content = "Check the [my_function][] for details."
6
7# The plugin typically runs within the MkDocs lifecycle
8# It allows referencing Python objects by their identifier 
9# (e.g., [pkg.mod.func][]) and automatically links them to 
10# their rendered documentation page.
11
12# To use it in your MkDocs project, add it to mkdocs.yml:
13# plugins:
14#   - autorefs
15#   - mkdocstrings