Contributing

If you find a bug or wish to request a feature, feel free to open a new issue.

PRs are welcome and appreciated, but please open an issue first to discuss the change you'd like to make first. PRs that haven't been discussed, or that fall outside the intended scope of this project, may be closed without merging.

Local Development

Upgrade pip and install the dependencies:

python -m pip install --upgrade pip
pip install pylint mkdocs natsort setuptools

Installing a local copy of the plugin (potentially from your MkDoc's venv location):

pip install -e /path/to/mkdocs-alias-plugin/

Run the linter:

pylint $(git ls-files '*.py')