vee1e/mitmproxy
1
0
Fork 0
mirror of https://github.com/vee1e/mitmproxy.git synced 2026-09-02 10:47:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
mitmproxy/docs
History
Thomas Bucaioni 90686abe82
Add example, according to issue #3752 (#6094) 
* Add example, according to issue #3752

* Add list options

* Replace generic IPs

* Remove chars < and >

* Update docs/src/content/concepts-options.md

Perfect

Co-authored-by: Maximilian Hils <github@maximilianhils.com>

---------

Co-authored-by: Maximilian Hils <github@maximilianhils.com>
2023-05-08 09:30:59 +00:00
..
bucketassets master branch -> main branch 2021-03-30 15:30:45 +02:00
raw
scripts [autofix.ci] apply automated fixes 2023-02-27 08:37:11 +01:00
src Add example, according to issue #3752 (#6094) 2023-05-08 09:30:59 +00:00
.gitignore
build.py make it black! 2022-04-28 19:11:10 +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
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.