mitmproxy/docs
stephenspol c77decf054
Added Docs for Transparent Mode on Windows (#5672)
* Added docs for transparent mode on Windows

* Added changes to CHANGELOG.md

* Update CHANGELOG.md

* Update howto-transparent.md

Co-authored-by: Maximilian Hils <github@maximilianhils.com>
2022-10-24 15:18:38 +00:00
..
bucketassets master branch -> main branch 2021-03-30 15:30:45 +02:00
raw
scripts don't remove add_log but deprecate it. 2022-09-18 13:45:37 +02:00
src Added Docs for Transparent Mode on Windows (#5672) 2022-10-24 15:18:38 +00:00
.gitignore
build.py make it black! 2022-04-28 19:11:10 +02:00
modd.conf
README.md Update README.md (#4620) 2021-06-04 09:14:11 +00: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 ./build.py to generate additional documentation source files.
  3. Now you can change your working directory to ./src and run hugo server -D.