An MkDocs plugin allowing links to your pages using a custom alias
Project description
mkdocs-alias-plugin
An MkDocs plugin allowing links to your pages using a custom alias such as [[my-alias]]
or [[my-alias|My Title]]
.
The aliases are configured through the meta-sections of each page (see Usage below).
Rationale
I maintain a fairly large wiki and occasionally will restructure parts of it, resulting in many broken links. This plugin allows me to separate the wiki contents from the file system structure and resolves the paths during build time. Maybe this plugin will help you out as well.
Installation
Install the package using pip:
pip install mkdocs-alias-plugin
Then add the following entry to the plugins section of your mkdocs.yml
file:
plugins:
- alias
For further configuration, see the Options section below.
Usage
Add an alias
section to your page's meta block:
---
alias: wuthering-heights
---
Then, using the alias in the markdown content of your pages:
The song references [[wuthering-heights]].
Which, after the page builds, renders as a regular link to your page.
Or, a more advanced example by using the dictionary-style configuration instead to provide a different link title.
---
alias:
name: wuthering-heights
text: Wuthering Heights, a novel by Emily Brontë
---
If you'd like to supply your own link text instead on a link-by-link basis, you can do so using a pipe to separate the title from the alias:
The song references [[wuthering-heights|Wuthering Heights]].
Please refer to the MkDocs documentation for more information on how the meta-data block is used.
Options
You may customize the plugin by passing options into the plugin's configuration sections in mkdocs.yml
:
plugins:
- alias:
verbose: true
verbose
You may use the optional verbose
option to print more information about which aliases were used and defined during build. The default value is false
.
Troubleshooting
The link text looks like a path or URL
Your alias doesn't have link text defined and your page doesn't have a title H1 tag or a title
attribute in its meta data section. Once you add this, your link will render with the appropriate text.
My alias is not being replaced
WARNING - Alias 'my-alias' not found
The alias could not be found in the defined aliases, usually due to a typo. Enable verbose output in the plugin's configuration to display all of the found aliases.
"Alias already defined"
You're getting a message resembling this in your output:
WARNING - page-url: alias alias-name already defined in other-url, skipping.
Aliases must be unique. Ensure that you're not redefining the same alias for a different page. Rename one of them and the warning should go away.
Local Development
pip install -e /path/to/mkdocs-alias-plugin/
Changelog
0.2.0
Allow strings as aliases instead of dictionaries, which allows for the use of page titles in the link text of the alias.
This version also makes the text
key optional in the alias dictionary configuration, using the same page title link text instead if it's not provided.
0.1.1
Fixes a bunch of linter issues, but no new logic.
0.1.0
Initial release with all of the base logic in place.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mkdocs-alias-plugin-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 46dfd1ce9f1b38ee073b079ea3f35a8c30136e1638269a223e364ab46c420f8f |
|
MD5 | 41a3259adbefe99bfb8a7e66671ce201 |
|
BLAKE2b-256 | 4457b69916b43de9f4931564a2ca0c8ded043e5b98369435de8b09f143804c53 |
Hashes for mkdocs_alias_plugin-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a000bedca3ae6609bd69bb2d6c97be24dc50c1eda898a4573a50b4a76adc3045 |
|
MD5 | 840ac392d9a87c5b65ce4e484b83bb78 |
|
BLAKE2b-256 | 32f24e27fd50b32c878e5235eb7d7dc0daba03d25892ec95cc4a10759e65f6d8 |