Files
Rashil GandhiandClement Tsang 0ccee6233b feature: use light variant of theme automatically when terminal background is light (#1843)
This PR makes it so that a user can specify an automatic theme mode, to automatically switch between light and dark terminals based on what's detected. The user can then specify the light and dark themes (--theme-dark and --theme-light as args, and similarly via config).

This approach isn't super original, and it's based on the approach used by bat (though not 100% the same).

Note that this is done only at startup and not constantly checking.

Co-authored-by: Clement Tsang <34804052+ClementTsang@users.noreply.github.com>
2026-11-21 23:12:43 -05:00
..
…
…
…

Extended Documentation

This is where the extended documentation resides, hosted on GitHub Pages. We use MkDocs, Material for MkDocs, and mike.

Documentation is currently built using Python 3.11, though it should work fine with older versions.

Running locally

One way is to just run serve.sh. Alternatively, the manual steps are, assuming your current working directory is the bottom repo:

# Change directories to the documentation.
cd docs/

# Create and activate venv.
python -m venv venv
source venv/bin/activate

# Install requirements
pip install -r requirements.txt

# Run mkdocs
venv/bin/mkdocs serve

Deploying

Deploying is done via mike in order to get versioning. Typically, this is done through CI, but can be done manually if needed.

Nightly docs

cd docs
mike deploy nightly --push

Stable docs

cd docs

# Rename the previous stable version
mike retitle --push stable $OLD_STABLE_VERSION

# Set the newest version as the most recent stable version
mike deploy --push --update-aliases $RELEASE_VERSION stable

# Append a "(stable)" string to the end.
mike retitle --push $RELEASE_VERSION "$RELEASE_VERSION (stable)"