vee1e/mitmproxy
1
0
Fork 0
mirror of https://github.com/vee1e/mitmproxy.git synced 2026-09-02 02:37:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
mitmproxy/docs
History
aesyondu 438567f58c
docs(docs-readme): clarify documentation readme (#4538) 
* docs(docs-readme): clarify documentation readme

I was confused what `mitmproxy Python package` meant. At first I did `pipx install mitmproxy`, but that didn't work. Then I realized I needed it as a library/module, not cli.

Changed `build.sh` to `build.py` since it was deleted on commit a7d1f32c89

* Update README.md

Co-authored-by: Maximilian Hils <github@maximilianhils.com>
2021-04-06 15:40:13 +02:00
..
bucketassets master branch -> main branch 2021-03-30 15:30:45 +02:00
raw
scripts docker: clean up tmux dir in clirecording Dockerfile (#4542) 2021-04-05 10:08:57 +02:00
src master branch -> main branch 2021-03-30 15:30:45 +02:00
.gitignore restructure examples 2020-06-23 16:00:14 +02:00
build.py fix docs CI 2021-02-13 12:29:52 +01:00
ci.sh master branch -> main branch 2021-03-30 15:30:45 +02:00
modd.conf docs: first prototype to link from events to API reference 2021-02-05 09:15:54 +01:00
README.md docs(docs-readme): clarify documentation readme (#4538) 2021-04-06 15:40:13 +02: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/.

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. 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.