mirror of
https://github.com/facebook/docusaurus.git
synced 2025-12-31 23:54:25 +00:00
110 lines
3.3 KiB
Markdown
110 lines
3.3 KiB
Markdown
---
|
||
name: 🐛 Bug Report
|
||
about: Submit a bug report to help us improve
|
||
labels: 'bug, needs triage'
|
||
---
|
||
|
||
<!--
|
||
|
||
! PLEASE HELP US HELP YOU !
|
||
|
||
Make it obvious to understand and reproduce this bug.
|
||
Ideally, we should be able to understand it without running any code.
|
||
|
||
Bugs are fixed faster if you include:
|
||
- a repro repository to inspect the code
|
||
- an url to see the problem live (if possible)
|
||
|
||
Pro tip: create a reproducible demo of the bug with https://new.docusaurus.io
|
||
|
||
-->
|
||
|
||
## 🐛 Bug Report
|
||
|
||
### Prerequisites
|
||
|
||
<!--
|
||
IMPORTANT: Please check the following items before creating a issue.
|
||
Mark the checkbox by putting an X between the bracket.
|
||
This way we know you've done these steps first.
|
||
-->
|
||
|
||
- [ ] I'm using the latest version of Docusaurus.
|
||
- [ ] I have tried the `npm run clear` or `yarn clear` command.
|
||
- [ ] I have tried `rm -rf node_modules yarn.lock package-lock.json` and re-installing packages.
|
||
- [ ] I have tried creating a repro with https://new.docusaurus.io
|
||
- [ ] I have read the console error message carefully (if applicable)
|
||
|
||
### Description
|
||
|
||
(A clear and concise description of what the bug is.)
|
||
|
||
### Have you read the [Contributing Guidelines on issues](https://github.com/facebook/docusaurus/blob/master/CONTRIBUTING.md#reporting-new-issues)?
|
||
|
||
(Write your answer here.)
|
||
|
||
## Steps to reproduce
|
||
|
||
Use https://new.docusaurus.io to create a CodeSandbox reproducible demo of the bug.
|
||
|
||
(Write your steps here:)
|
||
|
||
1. Step 1...
|
||
1. Step 2...
|
||
1. Step 3...
|
||
|
||
## Expected behavior
|
||
|
||
<!--
|
||
How did you expect your project to behave?
|
||
It’s fine if you’re not sure your understanding is correct.
|
||
Write down what you thought would happen.
|
||
-->
|
||
|
||
(Write what you thought would happen.)
|
||
|
||
## Actual behavior
|
||
|
||
<!--
|
||
Did something go wrong?
|
||
Is something broken, or not behaving as you expected?
|
||
Describe this section in detail, and attach screenshots if possible.
|
||
Don't only say "it doesn't work"!
|
||
Please submit exhaustive and complete log messages (we also need the error strack-traces, not just the message).
|
||
Please read error messages carefully: it often tells you exactly what you are doing wrong
|
||
-->
|
||
|
||
(Write what happened. Add full console log messages and screenshots, if applicable.)
|
||
|
||
## Your environment
|
||
|
||
<!-- Include as many relevant details about the environment you experienced the bug in -->
|
||
|
||
- Public source code:
|
||
- Public site URL:
|
||
- Docusaurus version used:
|
||
- Environment name and version (e.g. Chrome 78.0.3904.108, Node.js 10.17.0):
|
||
- Operating system and version (e.g. Ubuntu 20.04.2 LTS):
|
||
|
||
## Reproducible demo
|
||
|
||
Use https://new.docusaurus.io to create a CodeSandbox reproducible demo of the bug.
|
||
|
||
(Paste the link to an example repo, including a `docusaurus.config.js`, and exact instructions to reproduce the issue.)
|
||
|
||
<!--
|
||
What happens if you skip this step?
|
||
|
||
Someone will read your bug report, and maybe will be able to help you,
|
||
but it’s unlikely that it will get much attention from the team. Eventually,
|
||
the issue will likely get closed in favor of issues that have reproducible demos.
|
||
|
||
Please remember that:
|
||
|
||
* Issues without reproducible demos have a very low priority.
|
||
* The person fixing the bug would have to do that anyway. Please be respectful of their time.
|
||
* You might figure out the issues yourself as you work on extracting it.
|
||
|
||
Thanks for helping us help you!
|
||
-->
|