mitmproxy/docs/README.md
Alexander Prinzhorn 231c8eefe3
Update README.md (#4620)
* Document Cookie header folding issues

* plural: *exists*, me: 😮

* link list

* Update README.md

* fair well modd

* minor wording fix

Co-authored-by: Maximilian Hils <git@maximilianhils.com>
2021-06-04 09:14:11 +00:00

714 B

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.