mitmproxy/docs
Maximilian Hils 4e8eef805b
migrate to new contentview API, make DNS interactive (#7670)
* migrate all views to new contentview API
* make DNS view interactive
* rename dns.Message to DNSMessage
2025-04-25 15:17:12 +00:00
..
bucketassets
raw
scripts introduce new contentview API (#7623) 2025-04-21 14:56:58 +02:00
src migrate to new contentview API, make DNS interactive (#7670) 2025-04-25 15:17:12 +00:00
.gitignore
build.py
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.