Contributing

LitMDX is open source and welcomes contributions of all kinds — bug reports, documentation fixes, feature proposals, and code.

Ways to contribute

Report a bug

Open an issue on GitHub with a minimal reproduction. Include your LitMDX version and Node/Bun version.

Suggest a feature

Start a GitHub Discussion to describe the use case before opening a PR.

Improve the docs

The docs/ folder is part of the repository. Small typo fixes and clarifications are always welcome — no issue needed.

Submit a pull request

Read the contributing guide, fork the repo, and open a PR against main. All PRs run the full test suite automatically.

Tip

Start by reading the Contributing Guide before submitting your first PR.

Development setup

git clone https://github.com/litmdx/litmdx.git
cd litmdx
bun install

# Build all packages (required before running the dev server)
bun run build:packages

# Start docs dev server
bun run dev

# Run all tests
bun run test

# Build the docs site
bun run build

For a full breakdown of dev workflows, linting, formatting, and project structure see CONTRIBUTING.md.

License

By contributing to LitMDX you agree that your contributions will be licensed under the Apache License 2.0. Be kind.