Grasscutters/mitmproxy
3
0
Fork 0
mirror of https://github.com/Grasscutters/mitmproxy.git synced 2024-11-29 02:57:19 +00:00
Code Issues Projects Releases Wiki Activity
4468046a26
mitmproxy/docs
History
nt8en 83b43b93a7
Fix a typo in addons-overview.md (#5088)
2022-01-25 09:39:54 +01:00
..
bucketassets master branch -> main branch 2021-03-30 15:30:45 +02:00
raw
scripts split tls_handshake hook into client/server and success/fail variants 2021-11-22 10:23:21 +01:00
src Fix a typo in addons-overview.md (#5088) 2022-01-25 09:39:54 +01:00
.gitignore
build.py Harden CI Pipeline (#4590) 2021-05-11 11:17:09 +02:00
modd.conf
README.md Update README.md (#4620) 2021-06-04 09:14:11 +00: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.