Grasscutters/mitmproxy
3
0
Fork 0
mirror of https://github.com/Grasscutters/mitmproxy.git synced 2024-11-23 00:01:36 +00:00
Code Issues Projects Releases Wiki Activity
48426d0a20
mitmproxy/docs
History
Aldo Cortesi 53827a36ae
Merge pull request #3025 from Kriechi/py36 
Python 3.5 is dead -- long live Python 3.6!
2018-04-01 08:59:47 +12: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 Merge pull request #3025 from Kriechi/py36 2018-04-01 08:59:47 +12:00
style docs: add auto-generated options reference 2018-03-25 13:42:55 +02:00
.gitignore docs: add auto-generated options reference 2018-03-25 13:42:55 +02:00
build-archive various docs improvements 2018-03-21 00:42:37 +01:00
build-current docs: add auto-generated options reference 2018-03-25 13:42:55 +02:00
ci fix cloudfront invalidation paths 2018-03-21 13:47:15 +01: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
README.md add README for docs install 2018-03-20 15:00:29 +01: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
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.