description:Please read the contribution guidelines before proceeding.
options:
- label:I've read the [contribution guidelines](https://github.com/squidfunk/mkdocs-material/blob/master/CONTRIBUTING.md) and wholeheartedly agree
required:true
- type:checkboxes
attributes:
label:I've found a bug and checked that ...
description:Make sure that your request fulfills all of the following requirements. If one requirement cannot be satisfied, you must explain in detail why.
options:
- label:... the problem doesn't occur with the `mkdocs` or `readthedocs` themes
- label:... the problem persists, even when I remove all of my overrides (`custom_dir`, ...)
- label:... the documentation does not mention anything about my problem
- label:... there are no open or closed issues that are related to my problem
- type:textarea
attributes:
label:Description
description:Please provide a brief (1-2 sentence) description of the bug
validations:
required:true
- type:textarea
attributes:
label:Expected behaviour
description:Please describe what you'd expect to happen
validations:
required:true
- type:textarea
attributes:
label:Actual behaviour
description:Please describe what is actually happening
validations:
required:true
- type:textarea
attributes:
label:Steps to reproduce
description:Please provide the steps necessary to reproduce the bug
placeholder:|-
1. ...
2. ...
3. ...
validations:
required:true
- type:textarea
attributes:
label:Package versions
description:Please provide all package versions (run the commands in backticks)
value:|-
- Python:`python --version`
- MkDocs:`mkdocs --version`
- Material:`pip show mkdocs-material | grep -E ^Version`
validations:
required:true
- type:textarea
attributes:
label:Configuration
description:Please provide your `mkdocs.yml` to a reasonable amount of detail
placeholder:|-
site_name:My Docs
site_url:https://example.com/docs
render:yaml
validations:
required:true
- type:textarea
attributes:
label:System information
description:Please provide your operating system and browser type and version
