{"id":1559,"library":"mkdocs-autorefs","title":"mkdocs-autorefs","description":"mkdocs-autorefs is an MkDocs plugin that automatically creates hyperlinks across pages and to specific sections within your documentation using a simple `[text][identifier]` syntax. It is currently at version 1.4.4 and is actively maintained with frequent, minor updates.","status":"active","version":"1.4.4","language":"en","source_language":"en","source_url":"https://github.com/mkdocstrings/autorefs","tags":["mkdocs","documentation","plugin","cross-referencing","autorefs"],"install":[{"cmd":"pip install mkdocs-autorefs","lang":"bash","label":"Install stable version"}],"dependencies":[{"reason":"mkdocs-autorefs is an MkDocs plugin and requires MkDocs to be installed to function.","package":"mkdocs","optional":false}],"imports":[{"note":"This import is typically only used for programmatic interaction with the plugin. Most users configure mkdocs-autorefs directly in their `mkdocs.yml` file.","symbol":"AutorefsPlugin","correct":"from mkdocs_autorefs.plugin import AutorefsPlugin"}],"quickstart":{"code":"site_name: My Docs\n\nplugins:\n  - search\n  - autorefs:\n      enabled: true # Optional, default is true\n      deduplicate_references: true # Optional, default is true\n\n# Example Markdown usage (e.g., in a file `docs/api.md`):\n# Link to another page: [Introduction][index.md]\n# Link to a section: [Installation steps][setup.md#installation]","lang":"yaml","description":"Add `autorefs` to the `plugins` section of your `mkdocs.yml`. Once configured, you can use the `[text][identifier]` syntax in your Markdown files. The identifier can be a page path (e.g., `index.md`) or a page path combined with a section heading (e.g., `page.md#section-heading`)."},"warnings":[{"fix":"Upgrade your Python environment to 3.9 or higher, or explicitly pin `mkdocs-autorefs<1.3.0` in your dependencies.","message":"Support for Python 3.8 was dropped in version 1.3.0. Projects using mkdocs-autorefs on Python 3.8 will fail to install or run.","severity":"breaking","affected_versions":">=1.3.0"},{"fix":"Update any code directly referencing these internal symbols to use their new names: `AUTOREF_RE` and `AutorefsInlineProcessor`.","message":"Internal constants and classes (`AUTO_REF_RE`, `AutoRefInlineProcessor`) were renamed in version 1.1.0 to `AUTOREF_RE` and `AutorefsInlineProcessor` respectively. Direct programmatic usage of the old names will break.","severity":"deprecated","affected_versions":">=1.1.0"},{"fix":"Ensure you are using `mkdocs-autorefs` version 1.0.1 or newer. It is generally recommended to use MkDocs 1.4+ for full compatibility and access to the latest features.","message":"Older versions (prior to 1.0.1) had compatibility issues with `MkDocsConfig` on MkDocs 1.3 and earlier. This could lead to build failures.","severity":"gotcha","affected_versions":"<1.0.1"}],"env_vars":null,"last_verified":"2026-04-09T00:00:00.000Z","next_check":"2026-07-08T00:00:00.000Z"}