Skip to content

Contributing

Thanks for considering a contribution to html-to-markdown. Every fix, feature, and documentation improvement helps.

Ways to contribute

Section titled “Ways to contribute”
  • Report a bug — open an issue with a minimal reproduction
  • Fix a bug — look for issues tagged good first issue or help wanted
  • Improve the docs — edit any page directly on GitHub using the pencil icon, or clone and run the site locally
  • Add a feature — open an issue first to discuss scope before writing code; large changes without prior discussion may not be accepted

Getting started

Section titled “Getting started”
Terminal window
git clone https://github.com/xberg-io/html-to-markdown.git
cd html-to-markdown
task setup          # installs deps, builds Rust extension, wires commit hooks
task test           # should pass before you make any changes

Full prerequisites and per-language build instructions are in CONTRIBUTING.md at the repo root.

Workflow

Section titled “Workflow”
  1. Fork the repo and create a branch: git checkout -b fix/your-change
  2. Make your change, add tests if applicable
  3. Run task test (Rust + Python) and pnpm test (JS/TS) as needed
  4. Commit using Conventional Commits — prek enforces this automatically
  5. Push and open a pull request against main

Documentation changes

Section titled “Documentation changes”

The docs site lives in docs/ and builds with Zensical:

Terminal window
uv sync --group doc
uv run --no-sync zensical serve         # live preview at localhost:8000
scripts/ci/docs/build.sh --strict       # what CI runs — fix all warnings before pushing

New pages go in docs/, must be added to nav: in mkdocs.yaml, and should follow the style already on the page you’re editing: terse, table-driven.

Getting help

Section titled “Getting help”

Found a bug or mistake on this page?

If something here is wrong or out of date, open an issue on GitHub or contribute a fix via pull request.