Autorefs
Automatically link across pages in MkDocs.
Overview
If you're using MkDocs for documentation, the mkdocs-autorefs plugin is a game changer. This powerful tool simplifies the way you link to headings across different pages, allowing for a more streamlined experience without the hassle of knowing the path to every document. Whether your files are deeply nested or regularly moved, this plugin makes it easy to create accessible documentation.
By generating anchors for each heading automatically, mkdocs-autorefs allows you to create links that connect various pages with just the heading title. This is not only user-friendly but also saves you time and effort, ensuring your documentation is always up-to-date.
Features
- Automatic Anchors: Automatically generates anchors for each heading in your documents, simplifying cross-page linking.
- Pathless Linking: Link to headings from any page without needing to know the file path, making it easier to navigate complex structures.
- Warning Notifications: If non-unique headings are used, the plugin will log a warning, prompting you to make headings unique for clarity.
- Markdown Anchors: Add custom anchors for unique referencing using simple Markdown syntax.
- Resolve Closest Option: Automatically resolves links by finding the closest URL if multiple matches exist, enhancing usability.
- Handling of Nested Paths: Effectively manages links in deeply nested directories, alleviating the complexity of long file paths.
- User Friendly: Designed for both beginners and seasoned developers, making documentation writing more efficient and less error-prone.
- MkDocs
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
