Rooba
/
mitmproxy
mirror of https://github.com/mitmproxy/mitmproxy.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md (#4620) 

* Document Cookie header folding issues

* plural: *exists*, me: 😮

* link list

* Update README.md

* fair well modd

* minor wording fix

Co-authored-by: Maximilian Hils <git@maximilianhils.com>
This commit is contained in:
Alexander Prinzhorn 2021-06-04 11:14:11 +02:00 committed by GitHub
parent ce2d36dbab
commit 231c8eefe3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/README.md
View File

@ -2,20 +2,13 @@
This directory houses the mitmproxy documentation available at <https://docs.mitmproxy.org/>.
## Quick Start
## Prerequisites
1. Install [hugo "extended"](https://gohugo.io/getting-started/installing/).
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](../CONTRIBUTING.md#development-setup) for details.
4. Run `./build.py` to generate additional documentation source files.
2. Windows users: Depending on your git settings, you may need to manually create a symlink from `/docs/src/examples` to `/examples`.
Now you can run `hugo server -D` in ./src.
## Editing docs locally
## 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.
1. Make sure the mitmproxy Python package is installed and the virtual python environment was activated. See [CONTRIBUTING.md](../CONTRIBUTING.md#development-setup) 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`.