vee1e/mitmproxy
1
0
Fork 0
mirror of https://github.com/vee1e/mitmproxy.git synced 2026-09-01 10:18:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
mitmproxy/docs
History
Maximilian Hils 3915c5af78
Revise Proxy Mode Docs (#7545) 
* revise proxy mode documentation

* docs++

* [autofix.ci] apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-02-09 12:27:07 +01:00
..
bucketassets
raw
scripts Revise Proxy Mode Docs (#7545) 2025-02-09 12:27:07 +01:00
src Revise Proxy Mode Docs (#7545) 2025-02-09 12:27:07 +01:00
.gitignore
build.py Migrate to ruff (#6433) 2023-10-31 16:03:53 +01:00
modd.conf
README.md
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

  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.