Rooba
/
mitmproxy
mirror of https://github.com/mitmproxy/mitmproxy.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
mitmproxy/docs
History
Maximilian Hils dc3c400b6b add README for docs install 2018-03-20 15:00:29 +01: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 All new documentation 2018-02-22 18:07:58 +13:00
src docs: port changes in .css to .scss source 2018-03-05 10:09:18 +13:00
style docs: add robots.txt and error.html 2018-03-05 10:57:50 +13:00
.gitignore All new documentation 2018-02-22 18:07:58 +13:00
README.md add README for docs install 2018-03-20 15:00:29 +01:00
build docs: add build and upload scripts 2018-03-05 10:51:46 +13:00
ci docs: cloudfront invalidation 2018-03-07 22:45:08 +13:00
modd.conf All new documentation 2018-02-22 18:07:58 +13:00
package.json All new documentation 2018-02-22 18:07:58 +13:00
setup docs: add robots.txt and error.html 2018-03-05 10:57:50 +13:00
upload-archive docs: cloudfront invalidation 2018-03-07 22:45:08 +13:00
upload-stable docs: cloudfront invalidation 2018-03-07 22:45:08 +13:00
yarn.lock All new documentation 2018-02-22 18:07:58 +13: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.

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.