Support

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

Hi! 👋 We’re excited that you’re using unist (syntax-tree) and we’d love to help. To help us help you, please read through the following guidelines.

Please understand that people involved with this project often do so for fun, next to their day job; you are not entitled to free customer service.

Questions

Please chat and ask questions on Discussions! Jump in there and lurk, talk to us, and help others.

unified — topics relating to unified in general
remark — topics relating to the remark ecosystem, markdown, and mdast
rehype — topics relating to the rehype ecosystem, HTML, and hast
retext — topics relating to the retext ecosystem, natural language, and nlcst
MDX — topics relating to MDX
micromark — topics relating to the future of markdown in unified!
vfile — topics relating to vfile: virtual files
syntax-tree — topics relating to syntax-tree and unist

Asking quality questions

Help us help you!

Spending time framing a question and adding support links or resources makes it much easier for us to help. It’s easy to fall into the trap of asking something too specific when you’re close to a problem. Then, those trying to help you out have to spend a lot of time asking additional questions to understand what you are hoping to achieve.

Spending the extra time up front can help save everyone time in the long run.

try to define what you need help with:
- is there something in particular you want to do?
- what problem are you encountering and what steps have you taken to try and fix it?
- is there a concept you’re not understanding?
learn about the rubber duck debugging method
avoid falling for the XY problem
search on GitHub to see if a similar question has been asked
if possible, provide sample code, a CodeSandbox, or a video
the more time you put into asking your question, the better we can help you

Contributions

See contributing.md on how to contribute.

License

This document has the following license: CC-BY-4.0 © Titus Wormer