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/README.md
Maximilian Hils f1a925642f
do not copy hugo's install instructions 
that only creates maintenance burden
2021-04-21 12:00:57 +02:00

818 B
Raw Blame History

Mitmproxy Documentation

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

Quick Start

  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.
  3. Make sure the mitmproxy Python package is installed and the virtual python environment was activated. See CONTRIBUTING.md for details.
  4. Run ./build.py to generate additional documentation source files.

Now you can run hugo server -D in ./src.

Extended Install

This is required to modify CSS files.

  1. Install "extended" hugo version.

You can now run modd in this directory instead of running hugo directly.