mirror of
https://github.com/vee1e/mitmproxy.git
synced 2026-09-02 18:57:22 +00:00
| .. | ||
| bucketassets | ||
| raw | ||
| scripts | ||
| src | ||
| style | ||
| .gitignore | ||
| build-archive | ||
| build-current | ||
| ci | ||
| modd.conf | ||
| package.json | ||
| README.md | ||
| setup | ||
| upload-archive | ||
| upload-stable | ||
| yarn.lock | ||
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-currentto generate the documentation source files in./src/generated.
Now you can run hugo server -D in ./src.
Extended Install
This is required to modify CSS files.
- Install node, yarn, and modd.
- Run
yarnin this directory to get node-sass.
You can now run modd in this directory instead of running hugo directly.