Magic-Mirror/mitmproxy

mirror of https://github.com/mitmproxy/mitmproxy.git synced 2024-11-23 05:09:57 +00:00

History

Alexander Prinzhorn ccb3ae5abe Some checks failed CI / test (macos-latest, 3.13-dev) (push) Waiting to run Details CI / test (windows-latest, 3.13-dev) (push) Waiting to run Details CI / build (macos-12, macos-x86_64) (push) Waiting to run Details CI / build (macos-14, macos-arm64) (push) Waiting to run Details CI / build (windows-2019, windows) (push) Waiting to run Details CI / build-windows-installer (push) Waiting to run Details CI / check (push) Blocked by required conditions Details CI / deploy-docker (push) Blocked by required conditions Details CI / deploy (push) Blocked by required conditions Details autofix.ci / autofix (push) Failing after 0s Details CI / lint (push) Failing after 0s Details CI / filename-matching (push) Failing after 0s Details CI / mypy (push) Failing after 0s Details CI / individual-coverage (push) Failing after 0s Details CI / test (ubuntu-latest, 3.10) (push) Failing after 0s Details CI / test (ubuntu-latest, 3.11) (push) Failing after 0s Details CI / test (ubuntu-latest, 3.12) (push) Failing after 0s Details CI / test (ubuntu-latest, 3.13-dev) (push) Failing after 0s Details CI / test-old-dependencies (push) Failing after 0s Details CI / build (ubuntu-20.04, linux) (push) Failing after 0s Details CI / build-wheel (push) Failing after 0s Details CI / test-docker (push) Has been skipped Details CI / test-web-ui (push) Failing after 0s Details CI / docs (push) Failing after 0s Details Fix concepts-filters.md docs		2024-09-19 07:52:47 +00: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	Add `HttpConnectedHook` and `HttpConnectErrorHook` (#6930 )	2024-06-15 00:02:54 +05:30
src	Fix concepts-filters.md docs	2024-09-19 07:52:47 +00:00
.gitignore	restructure examples	2020-06-23 16:00:14 +02:00
build.py	Migrate to ruff (#6433 )	2023-10-31 16:03:53 +01: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

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

Editing docs locally

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