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.
pip install mkdocs-autorefsVerified import paths — ran on the pinned version, not inferred.
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`).
Upgrade your Python environment to 3.9 or higher, or explicitly pin `mkdocs-autorefs<1.3.0` in your dependencies.
Update any code directly referencing these internal symbols to use their new names: `AUTOREF_RE` and `AutorefsInlineProcessor`.
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.
Ensure that your MkDocs configuration file is correctly processed by the `mkdocs` command (e.g., `mkdocs build`, `mkdocs serve`) and not executed directly by the Python interpreter.
Add `autorefs` to the `plugins` section in your `mkdocs.yml` file: ```yaml plugins: - search - autorefs ```
Ensure all headings and Markdown anchors have unique identifiers across your documentation. Alternatively, use Markdown anchors with explicit IDs (e.g., `[]{#unique-id}` ) and reference those, or enable the `resolve_closest` option in the plugin's configuration to automatically resolve to the nearest link.Verify that the `identifier` within your `[text][identifier]` link exactly matches an existing heading (e.g., `## Answers File`) or a Markdown anchor (e.g., `[]{#answers_file}`). Ensure `mkdocs-autorefs` is correctly listed in your `mkdocs.yml` plugins section.Update `mkdocs-autorefs` to the latest version. If using custom plugin hooks, ensure they correctly access plugin options (e.g., `config.plugins['autorefs'].options['link_titles']`) and are compatible with the installed plugin version.