mitmproxy/docs/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-current to 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.

1. Install node, yarn, and modd.
2. Run yarn in this directory to get node-sass.

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