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 interested in contributing! Take a moment to read the following guidelines. And thanks for contributing to MDX!👏👌✨
If you’re raising an issue, 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.
Read the Support guidelines on the MDX website.
There’s several ways to contribute, not just by writing code.
It’s possible to support us financially by becoming a backer or sponsor of unified through Open Collective. With this support, we can pay for project leadership, finance non-coding work, or to do fun things for the community like getting stickers for contributors. You’ll be helping unified’s maintainers manage and improve existing projects, and additionally support our work to develop new and exciting projects, such as micromark.
As a user of this project you’re perfect for helping us improve our docs. Typo corrections, error fixes, better explanations, new examples, etcetera. Anything!
All MDX docs live in the
/docs directory. You can edit the files directly on GitHub or in your favorite text editor.
Some issues lack information, aren’t reproducible, or are just incorrect. Help make them easier to resolve.
We’re always looking for more opinions on discussions in the issue tracker.
Code contributions are very welcome. It’s often good to first create an issue to report a bug or suggest a new feature before creating a pull request to prevent you from doing unnecessary work.
Tests for an individual package can be run as a yarn workspace:
yarn workspace remark-mdx test. To see what packages are available to test you can list out all workspaces with
yarn workspaces info.
MDX is a monorepo that uses lerna.
./docsand can be viewed with
yarn docs -- -o
./examplesdirectory where examples for different tools and frameworks
In order to release a new version you can follow these steps:
yarn && yarn test && yarn lerna publish --force-publish
If you’re having issues installing locally you might need to run
yarn lerna exec yarn install instead of
yarn bootstrap (issue).