Installation¶

Installing the plugin¶

MkDocs-Test is an MkDocs plugin.

From pypi¶

pip install mkdocs-test

Locally (Github)¶

pip install .

Installing the test framework¶

Or, to install the test dependencies (for testing this package, not your MkDocs projects):

pip install .[test]

This will help you run your tests easily, using the pytest framework and command:

pip install pytest

Getting started¶

Now that the tools are installed, you can proceed to write and run the tests for your MkDocs project.