blob: a9ee11137a6bc4b7ac53bcdc8ee371d00b9a7d0b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
|
# Mitmproxy Documentation
This directory houses the mitmproxy documentation available at <https://docs.mitmproxy.org/>.
## Quick Start
1. Install [hugo](https://gohugo.io/).
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](https://github.com/cortesi/modd).
2. Run `yarn` in this directory to get node-sass.
You can now run `modd` in this directory instead of running hugo directly.
|
