mitmproxy/docs
2020-01-03 13:47:09 +01:00
..
bucketassets
raw
scripts
src docs: document no websocket replay 2020-01-03 13:47:09 +01:00
style
.gitignore
build-archive update release instructions 2019-12-21 02:57:53 +01:00
build-current
ci Use Github Actions for CI (#3713) 2019-11-19 18:15:08 +01:00
modd.conf
package.json
README.md improve wording 2019-10-13 18:20:38 +02:00
setup
upload-archive
upload-stable
yarn.lock

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.