1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
|
# Installation
## Installing the plugin
MkDocs-Test is an [MkDocs plugin](https://www.mkdocs.org/dev-guide/plugins/).
### From pypi
```sh
pip install mkdocs-test
```
### Locally (Github)
```sh
pip install .
```
### Installing the test framework
Or, to install the test dependencies (for testing _this_ package,
not your MkDocs projects):
```sh
pip install .[test]
```
This will help you run your tests easily,
using the [`pytest` framework and command](https://docs.pytest.org/en/stable/):
```sh
pip install pytest
```
### Getting started
Now that the tools are installed, you can proceed to [write and run the tests](how_to.md)
for your MkDocs project.
|
