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 02b982f000
windows install: document that installer is faster 
refs #5375
2022-05-26 14:12:25 +02:00
..
bucketassets
raw
scripts adjust to changes in pdoc 12 2022-05-15 19:16:36 +02:00
src windows install: document that installer is faster 2022-05-26 14:12:25 +02:00
.gitignore
build.py make it black! 2022-04-28 19:11:10 +02: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.