vee1e/mitmproxy
1
0
Fork 0
mirror of https://github.com/vee1e/mitmproxy.git synced 2026-09-01 10:18:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
mitmproxy/docs
History
Maximilian Hils 63a0b8d149
New Docs Layout (#7593) 
* wip

* wip

* docs: improve content structure

* make menu collapsible

* move anchor to the end of the heading

* layout fixes

* avoid menu items with the same name

* wip

* add CHANGELOG entry

* [autofix.ci] apply automated fixes

* fixup

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-03-09 10:54:14 +01:00
..
bucketassets
raw
scripts New Docs Layout (#7593) 2025-03-09 10:54:14 +01:00
src New Docs Layout (#7593) 2025-03-09 10:54:14 +01:00
.gitignore
build.py
modd.conf
README.md
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.