🔗 链接和参考
Links & references¶
Autolink References¶
Looks for the presence of a reference to tickets from issues trackers like Jira, Linear, etc and automatically convert them to links that point to respective platforms.
- author: Saurabh Kumar theskumar
- links: Github | PyPI
- installation:
pip install autolink-references-mkdocs-plugin
plugins:
- autolink_references:
autolinks:
- reference_prefix: AF-
target_url: https://linear.com/AF-<num>
- reference_prefix: PROJ-
target_url: https://jiracloud.com/PROJ-<num>autorefs¶
Automatically link across pages in MkDocs.
Why another "automatic cross linking" plugin? Because none of the other implementations were meeting our requirements for mkdocstrings. mkdocs-autorefs is actually performant (no HTML re-parsing), compatible with other plugins, and provides an easy-to-use syntax.
- authors: @oprypin and @pawamoy
- links: PyPI | GitHub | Docs
- installation:
pip install mkdocs-autorefs
ezlinks¶
Plugin for mkdocs which enables easier linking between pages.
This plugin was written in order to provide an up-to-date and feature complete plugin for easily referencing documents with a variety of features:
- File name linking (e.g. `[Text](file)`)
- Absolute paths (e.g. `[Text](/link/to/file.md)`)
- WikiLinks support (e.g. `[[Link]]`)unused-files¶
Find unused (orphaned) files in your project.
This is useful, e.g., if your project contains a lot of image files and you lost track which images are still in use.
A file is considered "used" when it is referenced in at least one Markdown file of your project, either as an image or as a hyperlink reference.
gitlab¶
Transform handles such as #1234, %56, !789, &12 or $34 into links to a gitlab repository, given by the gitlab_url configuration option.
- author: Mathieu Giraud
- links: PyPI | Gitlab
- installation:
pip install mkdocs-gitlab-plugin
autoreflinks¶
Automatically links heading references in the form [My heading], similar to Pandoc’s implicit_header_references extension.
- author: Paul Ouellette pauloue
- links: Github
- installation:
pip install git+https://github.com/pauloue/mkdocs-autoreflinks-plugin
autolinks¶
Simplifies relative linking between documents. Allows you to link to pages and images within your MkDocs site without providing the entire relative path to the file in your document structure.
- author: Zach Hannum midnightprioriem
- links: Github | Docs
- installation:
pip install mkdocs-autolinks-plugin
roamlinks¶
Inherit from autolinks, support [[mdfile]] -> [mdfile](path-to-file), also implicit heading [[#A Title]] -> [#A Title](#a-title)
- author: jackiexiao jackiexiao
- links: PyPI | Github | Docs
- installation:
pip install mkdocs-roamlinks-plugin
abs-to-rel¶
Mkdocs absolute to relative link converter. Mkdocs officially only supports relative links. While this makes sense there are situation where it is useful to make use of absolute links. For example when creating a document with absolute links to an image folder. If that file is to be moved later on, links are kept intact.
webcontext¶
Converting absolute image/link paths to webcontext aware paths. Use when you are not going to upload your MkDocs to the site root but rather a sub folder on an existing site. You will then be able to use the same absolute path (staring with "/") for development and after deploy. Examples of site urls before and after using the webcontext plugin: | Site Url | Context | Image before | Image after | | ---------------------- | ------- | ---------------- | -------------------- | | http://example.com/foo | /foo | /images/img1.jpg | /foo/images/img1.jpg |
- author: Darrel Kleynhans Darrelk
- links: PyPI | Github | Docs
- installation:
pip install mkdocs_webcontext_plugin
emailprotect¶
Obscures email addresses from address-harvesting spam bots.
- author: Roland Freikamp rkoe
- links Github | Docs
- installation:
pip install git+https://github.com/rkoe/mkdocs-emailprotect
linkpatcher-plugin¶
Extends the Markdown syntax by providing an alternative : header prefix, and provides special autolinking functionality for such headers.
- author: sekikawattt
- links: Github | Docs
- installation:
pip install git+https://github.com/sekikawattt/mkdocs-linkpatcher-plugin
redirects¶
Makes it easy to create dynamic page redirects, so you can move docs around and prevent broken links. Instead of using the meta “redirect:” support (which requires you to have extraneous Markdown files cluttering up your docs folder), this plugin dynamically generates the meta redirect HTML pages in the site_dir based on configuration in mkdocs.yml mapping old paths to new page locations.
htmlproofer¶
Validates URLs in rendered HTML files.
- author: Manu Zhang manuzhang
- links: Pypi | Github | Docs
- installation:
pip install mkdocs-htmlproofer-plugin
tooltipster-links¶
Not functional with current release of Mkdocs
Adds tooltips to preview the content of page links using tooltipster.
- author: Zach Hannum midnightprioriem
- links: Pypi | Github | Docs
- installation:
pip install mkdocs-tooltipster-links-plugin
alternate-link¶
Simplifies internal links. Very simple mkdocs plugin using John Gruber's relative path link as an alternate syntax for internal links, removing the need to add the .md suffix for the target page.
- author: Cristi Mitrana cmitu
- links: Github | Docs
- installation:
pip install git+https://github.com/cmitu/mkdocs-altlink-plugin/
mkdocs-alias-plugin¶
Allows linking to your pages using a custom alias, such as [[my-alias]]. The syntax of the alias is reminiscent of MediaWiki links, while aliases themselves are defined in the meta section of the Markdown document. This allows for a decoupling of the wiki page from the file system in case you make frequent changes to filenames or your directory structure without having to fix broken links.