forked from https://github.com/mitmproxy/mitmproxy/ (bubble branch has our minor changes) https://github.com/mitmproxy/mitmproxy/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Massimo Prencipe 34ab180bad
Fix broken link with link to similar addon. This fixes issue #3775.
4 years ago
..
bucketassets docs: add robots.txt and error.html 6 years ago
raw few more fixes,picture mod 6 years ago
scripts docs: add auto-generated options reference 6 years ago
src Fix broken link with link to similar addon. This fixes issue #3775. 4 years ago
style docs: fix minimum page height 5 years ago
.gitignore docs: add auto-generated options reference 6 years ago
README.md improve wording 4 years ago
build-archive update release instructions 4 years ago
build-current docs: add auto-generated options reference 6 years ago
ci Use Github Actions for CI (#3713) 4 years ago
modd.conf All new documentation 6 years ago
package.json All new documentation 6 years ago
setup abort doc scripts on error 6 years ago
upload-archive fix cloudfront invalidation paths 6 years ago
upload-stable fix cloudfront invalidation paths 6 years ago
yarn.lock All new documentation 6 years ago

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.