Grasscutters/mitmproxy
3
0
Fork 0
mirror of https://github.com/Grasscutters/mitmproxy.git synced 2024-11-26 02:10:59 +00:00
Code Issues Projects Releases Wiki Activity
5f5e2dc0ee
mitmproxy/docs
History
Maximilian Hils 7df0be34b0 docs++
2021-05-11 18:05:40 +02:00
..
bucketassets master branch -> main branch 2021-03-30 15:30:45 +02:00
raw few more fixes,picture mod 2018-02-25 22:52:12 +05:30
scripts docker: clean up tmux dir in clirecording Dockerfile (#4542) 2021-04-05 10:08:57 +02:00
src docs++ 2021-05-11 18:05:40 +02:00
.gitignore restructure examples 2020-06-23 16:00:14 +02:00
build.py Harden CI Pipeline (#4590) 2021-05-11 11:17:09 +02:00
modd.conf docs: first prototype to link from events to API reference 2021-02-05 09:15:54 +01:00
README.md do not copy hugo's install instructions 2021-04-21 12:00:57 +02:00
setup.sh docs: rename docs scripts and improve template 2020-04-11 12:25:56 +02:00
upload-archive.sh Improve Shell Script syntax (#4497) 2021-03-11 19:12:03 +01:00
upload-stable.sh clean doc folder before building, fixes #4405 (#4406) 2021-01-22 01:40:08 +01:00

README.md

Mitmproxy Documentation

This directory houses the mitmproxy documentation available at https://docs.mitmproxy.org/.

Quick Start

  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.
  3. Make sure the mitmproxy Python package is installed and the virtual python environment was activated. See CONTRIBUTING.md for details.
  4. Run ./build.py 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 "extended" hugo version.

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