Rooba
/
mitmproxy
mirror of https://github.com/mitmproxy/mitmproxy.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
mitmproxy/docs
History
Maximilian Hils d51df5f896 fix docs CI 2024-12-05 10:27:21 +01:00
..
bucketassets master branch -> main branch 2021-03-30 15:30:45 +02:00
raw
…
scripts Add `HttpConnectedHook` and `HttpConnectErrorHook` (#6930) 2024-06-15 00:02:54 +05:30
src fix docs CI 2024-12-05 10:27:21 +01:00
.gitignore
…
README.md Update README.md (#4620) 2021-06-04 09:14:11 +00:00
build.py Migrate to ruff (#6433) 2023-10-31 16:03:53 +01:00
modd.conf docs: first prototype to link from events to API reference 2021-02-05 09:15:54 +01:00
setup.sh
…
upload-archive.sh Improve Shell Script syntax (#4497) 2021-03-11 19:12:03 +01:00
upload-stable.sh clean doc folder before building, fixes #4405 (#4406) 2021-01-22 01:40:08 +01:00

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.