vee1e/mitmproxy
1
0
Fork 0
mirror of https://github.com/vee1e/mitmproxy.git synced 2026-09-01 18:27:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
mitmproxy/docs
History
Maximilian Hils f36dcd8915
revise map local docs 
provide a short summary at the start (with easy-to-copy examples) and then discuss the nitty-gritty details below.
2020-07-14 15:55:31 +02:00
..
bucketassets
raw
scripts restructure examples 2020-06-23 16:00:14 +02:00
src revise map local docs 2020-07-14 15:55:31 +02:00
.gitignore restructure examples 2020-06-23 16:00:14 +02:00
build.sh restructure examples 2020-06-23 16:00:14 +02:00
ci.sh docs: rename docs scripts and improve template 2020-04-11 12:25:56 +02:00
modd.conf fix docs generation 2020-06-25 17:02:12 +02:00
README.md docs: rename docs scripts and improve template 2020-04-11 12:25:56 +02:00
setup.sh docs: rename docs scripts and improve template 2020-04-11 12:25:56 +02:00
upload-archive.sh docs: rename docs scripts and improve template 2020-04-11 12:25:56 +02:00
upload-stable.sh docs: rename docs scripts and improve template 2020-04-11 12:25:56 +02: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.sh to generate additional documentation source files.

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.