Contributing

HTMLTab is an open-source project and contributions are welcome.

Setting up a development environment

HTMLTab is written in Python and uses uv for project management. Install uv before you do anything else.

Create a fork of HTMLTab under your own GitHub account, and then clone that repo on your computer:

git clone git@github.com:YOURNAME/htmltab

Note

If you want to get started without creating a fork, clone the original repo instead:

git clone git@github.com:flother/htmltab

Now you can use uv to create a virtual environment:

uv venv --python 3.12

And then install the project’s dependencies:

uv sync

Once that’s complete, activate the virtual environment:

source .venv/bin/activate

Now you’re ready to start developing! You can run HTMLTab, and any changes you make will be reflected in the command-line program:

htmltab --help

Serving the documentation locally

HTMLTab’s documentation — the documentation you’re reading now — can be found in the repo’s docs sub-directory. It’s written in Markdown and converted to HTML using MkDocs. You can run the MkDocs server locally with uv:

uvx --with mkdocs-material==9 mkdocs@1.6 serve

You can then view the documentation in your browser at http://localhost:8000/. Any changes you make to the docs will be reflected in your browser.

When changes are committed to the master branch, a GitHub Actions workflow (.github/workflows/publish_docs.yml) will publish the latest docs to https://flother.github.io/htmltab.