vee1e/mitmproxy
1
0
Fork 0
mirror of https://github.com/vee1e/mitmproxy.git synced 2026-09-02 18:57:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
mitmproxy/docs
History
Maximilian Hils 8d6a279818 add very basic DNS API docs 
the rest still needs to be done, but this should serve as a template
2022-04-23 13:33:18 +02:00
..
bucketassets
raw
scripts add very basic DNS API docs 2022-04-23 13:33:18 +02:00
src add very basic DNS API docs 2022-04-23 13:33:18 +02:00
.gitignore
build.py
modd.conf
README.md Update README.md (#4620) 2021-06-04 09:14:11 +00:00
setup.sh
upload-archive.sh
upload-stable.sh

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.