mitmproxy/docs
Alessandro Surace 1a489f6a8c
docs: how to create the proper CA (#5370)
Co-authored-by: Maximilian Hils <git@maximilianhils.com>
2024-03-11 10:10:06 +00:00
..
bucketassets
raw
scripts Migrate to ruff (#6433) 2023-10-31 16:03:53 +01:00
src docs: how to create the proper CA (#5370) 2024-03-11 10:10:06 +00:00
.gitignore
build.py Migrate to ruff (#6433) 2023-10-31 16:03:53 +01:00
modd.conf
README.md
setup.sh
upload-archive.sh
upload-stable.sh

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.