Rooba
/
mitmproxy
mirror of https://github.com/mitmproxy/mitmproxy.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
mitmproxy/docs
History
Thomas Kriechbaumer 12b37c39e1 docs: render all examples into one markdown page 2020-04-10 14:08:25 +02:00
..
bucketassets docs: add robots.txt and error.html 2018-03-05 10:57:50 +13:00
raw few more fixes,picture mod 2018-02-25 22:52:12 +05:30
scripts docs: add auto-generated options reference 2018-03-25 13:42:55 +02:00
src docs: render all examples into one markdown page 2020-04-10 14:08:25 +02:00
.gitignore docs: render all examples into one markdown page 2020-04-10 14:08:25 +02:00
README.md Remove yarn/npm from docs 2020-02-25 03:38:10 +05:30
build-archive update release instructions 2019-12-21 02:57:53 +01:00
build-current docs: render all examples into one markdown page 2020-04-10 14:08:25 +02:00
ci Use Github Actions for CI (#3713) 2019-11-19 18:15:08 +01:00
modd.conf Remove yarn/npm from docs 2020-02-25 03:38:10 +05:30
render_examples.py docs: render all examples into one markdown page 2020-04-10 14:08:25 +02:00
setup abort doc scripts on error 2018-03-20 15:04:31 +01:00
upload-archive fix cloudfront invalidation paths 2018-03-21 13:47:15 +01:00
upload-stable fix cloudfront invalidation paths 2018-03-21 13:47:15 +01:00

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 hugo extended version.

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