mitmproxy/docs
Maximilian Hils 1093323e00
docs: add local capture mode (#7540)
* docs: add local capture mode

* [autofix.ci] apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-02-08 15:42:54 +01:00
..
bucketassets
raw
scripts Update ruff requirement from <=0.8.6,>=0.5.0 to >=0.5.0,<=0.9.4 (#7528) 2025-02-01 23:21:33 +00:00
src docs: add local capture mode (#7540) 2025-02-08 15:42:54 +01:00
.gitignore
build.py
modd.conf
README.md
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 ./build.py to generate additional documentation source files.
  3. Now you can change your working directory to ./src and run hugo server -D.