Magic-Mirror/mitmproxy
1
0
Fork 0
mirror of https://github.com/mitmproxy/mitmproxy.git synced 2025-02-18 12:48:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
mitmproxy/docs
History
Manuel Meitinger af2251c2ef [dns] minor fixes
2022-03-27 15:23:59 +02:00
..
bucketassets
master branch -> main branch
2021-03-30 15:30:45 +02:00
raw
few more fixes,picture mod
2018-02-25 22:52:12 +05:30
scripts
[dns] minor fixes
2022-03-27 15:23:59 +02:00
src
docs: fix options generation, add anchors
2022-03-15 19:02:43 +01:00
.gitignore
restructure examples
2020-06-23 16:00:14 +02:00
build.py
Harden CI Pipeline (#4590)
2021-05-11 11:17:09 +02:00
modd.conf
docs: first prototype to link from events to API reference
2021-02-05 09:15:54 +01:00
README.md
Update README.md (#4620)
2021-06-04 09:14:11 +00:00
setup.sh
docs: rename docs scripts and improve template
2020-04-11 12:25:56 +02:00
upload-archive.sh
Improve Shell Script syntax (#4497)
2021-03-11 19:12:03 +01:00
upload-stable.sh
clean doc folder before building, fixes #4405 (#4406)
2021-01-22 01:40:08 +01:00

README.md

Mitmproxy Documentation

This directory houses the mitmproxy documentation available at https://docs.mitmproxy.org/.

Prerequisites

  1. Install hugo "extended".
  2. Windows users: Depending on your git settings, you may need to manually create a symlink from /docs/src/examples to /examples.

Editing docs locally

  1. Make sure the mitmproxy Python package is installed and the virtual python environment was activated. See CONTRIBUTING.md for details.
  2. Run ./build.py to generate additional documentation source files.
  3. Now you can change your working directory to ./src and run hugo server -D.