mitmproxy/docs
Aroh Maurya bae1a7e179
docs: mention Microsoft Store install on Windows (#8374)
The Windows installation instructions only pointed at the installer and
standalone binaries from mitmproxy.org, even though every release is also
published to the Microsoft Store by CI (release/deploy-microsoft-store.py).

Refs #6053.
2026-08-13 15:50:59 +02:00
..
bucketassets
raw
scripts introduce new contentview API (#7623) 2025-04-21 14:56:58 +02:00
src docs: mention Microsoft Store install on Windows (#8374) 2026-08-13 15:50:59 +02:00
.gitignore
build.py Use sys.executable instead of python3 in docs build script (#8183) 2026-04-19 14:50:02 +02:00
modd.conf
README.md Update README.md (#7594) 2025-03-09 11:02:09 +01:00
setup.sh
upload-archive.sh
upload-stable.sh

Mitmproxy Documentation

This directory houses the mitmproxy documentation available at https://docs.mitmproxy.org/.

Prerequisites

  1. Install hugo "extended".
  2. Windows users: Depending on your git settings, you may need to manually create a symlink from /docs/src/examples to /examples.

Editing docs locally

  1. Make sure the mitmproxy Python package is installed and the virtual python environment was activated. See CONTRIBUTING.md for details.
  2. Run ./docs/build.py to generate additional documentation source files.
  3. Now you can change your working directory to ./docs/src and run hugo server -D.