Grasscutters/mitmproxy
3
0
Fork 0
mirror of https://github.com/Grasscutters/mitmproxy.git synced 2024-11-23 00:01:36 +00:00
Code Issues Projects Releases Wiki Activity
1c9e9660b8
mitmproxy/docs
History
Thomas Kriechbaumer ff16fbf71e fix docs ci script running locally
2020-11-08 13:17:38 +01:00
..
bucketassets
raw
scripts fix linting error 2020-09-04 18:51:02 +02:00
src is_http10 and is_http11 properties to requests 2020-10-13 09:21:15 -05:00
.gitignore restructure examples 2020-06-23 16:00:14 +02:00
build.sh add cli recording scripts 2020-09-03 17:44:00 +02:00
ci.sh fix docs ci script running locally 2020-11-08 13:17:38 +01:00
modd.conf fix docs generation 2020-06-25 17:02:12 +02:00
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/.

Quick Start

  1. Install hugo.
  2. Windows users: Depending on your git settings, you may need to manually create a symlink from /docs/src/examples to /examples.
  3. Make sure the mitmproxy Python package is installed.
  4. Run ./build.sh to generate additional documentation source files.

Now you can run hugo server -D in ./src.

Extended Install

This is required to modify CSS files.

  1. Install hugo extended version.

You can now run modd in this directory instead of running hugo directly.