mitmproxy/docs
Maximilian Hils 139a385900
Merge pull request #3441 from petersmythe/patch-1
Fix spelling issues
2019-01-23 13:08:51 +01:00
..
bucketassets
raw
scripts
src
style
.gitignore
README.md
build-archive
build-current
ci
modd.conf
package.json
setup
upload-archive
upload-stable
yarn.lock

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.

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.