mirror of
https://github.com/mitmproxy/mitmproxy.git
synced 2024-11-23 13:19:48 +00:00
08895e9ba6
- restructure examples (fix #4031) - remove example dependencies from setup.py, we do not need special dependencies for our supported addons. - unify how we generate docs from code - improve example docs |
||
|---|---|---|
| .. | ||
| bucketassets | ||
| raw | ||
| scripts | ||
| src | ||
| .gitignore | ||
| build.sh | ||
| ci.sh | ||
| modd.conf | ||
| README.md | ||
| setup.sh | ||
| upload-archive.sh | ||
| upload-stable.sh | ||
Mitmproxy Documentation
This directory houses the mitmproxy documentation available at https://docs.mitmproxy.org/.
Quick Start
- Install hugo.
- Windows users: Depending on your git settings, you may need to manually create a symlink from /docs/src/examples to /examples.
- Make sure the mitmproxy Python package is installed.
- Run
./build.shto generate additional documentation source files.
Now you can run hugo server -D in ./src.
Extended Install
This is required to modify CSS files.
- Install hugo extended version.
You can now run modd in this directory instead of running hugo directly.