Grasscutters/mitmproxy
3
0
Fork 0
mirror of https://github.com/Grasscutters/mitmproxy.git synced 2024-11-22 07:08:10 +00:00
Code Issues Projects Releases Wiki Activity
05a43572c8
mitmproxy/docs
History
Maximilian Hils 05a43572c8 make development setup instructions more clear 
Our dev.sh/dev.ps1 scripts feel like an unnecessary layer of abstraction.
The revised docs make the install process transparent to experienced users,
and can also be easily reused for other projects (hi, pdoc!).
2021-01-18 13:56:27 +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 converge on hooks, events, and commands 2021-01-05 22:00:54 +01:00
src converge on hooks, events, and commands 2021-01-05 22:00:54 +01:00
.gitignore restructure examples 2020-06-23 16:00:14 +02:00
build.sh add cli recording scripts 2020-09-03 17:44:00 +02:00
ci.sh fix docs ci script running locally 2020-11-08 13:17:38 +01:00
modd.conf fix docs generation 2020-06-25 17:02:12 +02:00
README.md make development setup instructions more clear 2021-01-18 13:56:27 +01: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 "extended" hugo version.

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