vee1e/mitmproxy
1
0
Fork 0
mirror of https://github.com/vee1e/mitmproxy.git synced 2026-09-01 18:27:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
mitmproxy/docs
History
Maximilian Hils 805aed4f6a docs++
2021-02-13 00:13:37 +01:00
..
bucketassets
raw
scripts docs++ 2021-02-13 00:13:37 +01:00
src docs++ 2021-02-13 00:13:37 +01:00
.gitignore
build.py docs++ 2021-02-13 00:13:37 +01:00
ci.sh docs++ 2021-02-13 00:13:37 +01:00
modd.conf docs: first prototype to link from events to API reference 2021-02-05 09:15:54 +01:00
README.md make development setup instructions more clear 2021-01-18 13:56:27 +01:00
setup.sh
upload-archive.sh
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/.

Quick Start

  1. Install hugo.
  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.
  4. Run ./build.sh 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.