mitmproxy/docs
Manuel Meitinger 891dae031c
Make default_port protocol specific. (#5563)
* [modes] make default_port protocol specific

* fix nits

Co-authored-by: Maximilian Hils <git@maximilianhils.com>
2022-09-07 12:14:48 +00:00
..
bucketassets
raw
scripts Add support for raw UDP. (#5414) 2022-07-27 02:20:30 +02:00
src Make default_port protocol specific. (#5563) 2022-09-07 12:14:48 +00:00
.gitignore
build.py make it black! 2022-04-28 19:11:10 +02:00
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.