History

Maximilian Hils 02b982f000 windows install: document that installer is faster refs #5375		2022-05-26 14:12:25 +02:00
..
bucketassets	…
raw	…
scripts	adjust to changes in pdoc 12	2022-05-15 19:16:36 +02:00
src	windows install: document that installer is faster	2022-05-26 14:12:25 +02:00
.gitignore	…
README.md	…
build.py	…
modd.conf	…
setup.sh	…
upload-archive.sh	…
upload-stable.sh	…

README.md

Mitmproxy Documentation

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

Prerequisites

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

Editing docs locally

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