Overview

Interested in contributing to MD-Plugins? Here’s how you can contribute.

Working Together

MD-Plugins is free to use under the MIT License. The project grows through feedback, documentation, tests, examples, bug reports, and pull requests from people using it in real projects.

Contributions are not limited to code. We welcome:

  • Bug reports and reproductions.
  • Documentation fixes.
  • Examples that show practical usage.
  • Tests for Markdown plugins and Q-Press behavior.
  • Pull requests that improve the developer experience.

Working In The Open

MD-Plugins lives on GitHub. Work, discussion, issues, bugs, features, improvements, and comments happen in public so everyone can follow along.

If you notice something that could be improved, you have two good options:

  1. Open an issue for the request. We’ll review it and help decide the next step.

  2. Begin the work yourself and contribute it back with a pull request. Works-in-progress are welcome, especially when the direction would benefit from early feedback.

If working with GitHub sounds like a lot, check out this free video series.

Before You Start

Before submitting a pull request, run the checks that match your change:

pnpm check:all

Thanks for helping make MD-Plugins better for everyone.