mitmproxy/docs
Gaurav Jain dfb2b273a2
Updates docs for DNS and HTTP/3 mode (#7474)
* Update docs

* fix typo

* fix capitalization

---------

Co-authored-by: Maximilian Hils <git@maximilianhils.com>
2025-01-13 12:04:08 +00:00
..
bucketassets
raw
scripts
src Updates docs for DNS and HTTP/3 mode (#7474) 2025-01-13 12:04:08 +00:00
.gitignore
README.md
build.py
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
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.