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
Thomas Kriechbaumer 5ea75a1a81 examples: reformat to prevent too long lines
2020-04-11 11:12:18 +02:00
..
bucketassets
raw
scripts
src docs: render all examples into one markdown page 2020-04-10 14:08:25 +02:00
.gitignore docs: render all examples into one markdown page 2020-04-10 14:08:25 +02:00
build-archive update release instructions 2019-12-21 02:57:53 +01:00
build-current docs: render all examples into one markdown page 2020-04-10 14:08:25 +02:00
ci Use Github Actions for CI (#3713) 2019-11-19 18:15:08 +01:00
modd.conf Remove yarn/npm from docs 2020-02-25 03:38:10 +05:30
README.md Remove yarn/npm from docs 2020-02-25 03:38:10 +05:30
render_examples.py examples: reformat to prevent too long lines 2020-04-11 11:12:18 +02:00
setup
upload-archive
upload-stable

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-current to generate the documentation source files in ./src/generated.

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

Extended Install

This is required to modify CSS files.

  1. Install hugo extended version.

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