python3-mkdocs-autorefs-1.0.1-1.lbn36.noarch

mkdocs-autorefs

Automatically link across pages in MkDocs. Installation With pip: python3 -m pip install mkdocs-autorefs

Usage

plugins: - search - autorefs

In one of your Markdown files (e.g. doc1.md) create some headings:

Link to [Hello, World!](#hello-world) on the same page.

This is a normal link to an anchor. MkDocs generates anchors for each heading, and they can always be used to link to something, either within the same page (as shown here) or by specifying the path of the other page. But with this plugin, you can link to a heading from any other page on the site without needing to know the path of either of the pages, just the heading title itself. Let's create another Markdown page to try this, subdir/doc2.md: We can [link to that heading][hello-world] from another page too.

This works the same as [a normal link to that heading](../doc1.md#hello-world).

Linking to a heading without needing to know the destinatio