mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
71 lines
1.7 KiB
Markdown
71 lines
1.7 KiB
Markdown
|
---
|
||
|
name: Bug
|
||
|
about: Report a bug
|
||
|
---
|
||
|
|
||
|
<!--
|
||
|
⚠️ WARNING
|
||
|
|
||
|
Half of all issues created do not contain enough information to help or are
|
||
|
not appropriate for the issue tracker (i.e. one-line questions). If you think
|
||
|
you found a bug, follow the steps outlined below closely. Any issue that does
|
||
|
not meet these conditions may be closed unnoticed.
|
||
|
|
||
|
Why? Because the maintainers of this project are wasting a lot of time
|
||
|
answering questions that are not directly related to this project.
|
||
|
-->
|
||
|
|
||
|
__Checklist__:
|
||
|
|
||
|
<!-- Make sure that your request fulfills all of the following requirements -->
|
||
|
|
||
|
I checked that...
|
||
|
|
||
|
- [ ] ... the documentation does not mention anything about my problem
|
||
|
- [ ] ... the problem doesn't occur with the default MkDocs template
|
||
|
- [ ] ... the problem is not in any of my customizations (CSS, JS, template)
|
||
|
- [ ] ... there are no open or closed issues that are related to my problem
|
||
|
|
||
|
## Description
|
||
|
|
||
|
<!-- Please provide a brief description of the bug -->
|
||
|
|
||
|
### Expected behavior
|
||
|
|
||
|
<!-- Please describe what you expected to happen -->
|
||
|
|
||
|
### Actual behavior
|
||
|
|
||
|
<!-- Please describe what is actually happening -->
|
||
|
|
||
|
### Steps to reproduce the bug
|
||
|
|
||
|
<!-- Please provide the steps to repoduce the issue -->
|
||
|
|
||
|
1. ...
|
||
|
2. ...
|
||
|
3. ...
|
||
|
|
||
|
### Package versions
|
||
|
|
||
|
<!-- Please provide all package versions -->
|
||
|
|
||
|
* Python: `python --version`
|
||
|
* MkDocs: `mkdocs --version`
|
||
|
* Material: `pip show mkdocs-material | grep -E ^Version`
|
||
|
|
||
|
### Project configuration
|
||
|
|
||
|
<!-- Please provide your mkdocs.yml to a REASONABLE amount of detail -->
|
||
|
|
||
|
``` yaml
|
||
|
The contents of your mkdocs.yml
|
||
|
```
|
||
|
|
||
|
### System information
|
||
|
|
||
|
<!-- Please provide your operating system and browser version -->
|
||
|
|
||
|
* OS: [The operating system you're running]
|
||
|
* Browser: [The browser used, if relevant]
|