mirror of
https://github.com/vee1e/mitmproxy.git
synced 2026-09-01 18:27:18 +00:00
* Update Hugo installed in CI from `v0.92.1` to `v0.139.3` The version in CI is close to 3 years old, which means it does not encounter the same problems that newer installations of Hugo do. * Fix Hugo deprecation error I got the following error when building the documentation with Hugo `v0.139.3`: ``` ERROR deprecated: data.GetJSON was deprecated in Hugo v0.123.0 and will be removed in Hugo 0.140.0. use resources.Get or resources.GetRemote with transform.Unmarshal. ``` I fixed the error by implementing the change the error recommended. |
||
|---|---|---|
| .. | ||
| bucketassets | ||
| raw | ||
| scripts | ||
| src | ||
| .gitignore | ||
| build.py | ||
| modd.conf | ||
| README.md | ||
| setup.sh | ||
| upload-archive.sh | ||
| upload-stable.sh | ||
Mitmproxy Documentation
This directory houses the mitmproxy documentation available at https://docs.mitmproxy.org/.
Prerequisites
- Install hugo "extended".
- Windows users: Depending on your git settings, you may need to manually create a symlink from
/docs/src/examplesto/examples.
Editing docs locally
- Make sure the mitmproxy Python package is installed and the virtual python environment was activated. See CONTRIBUTING.md for details.
- Run
./build.pyto generate additional documentation source files. - Now you can change your working directory to
./srcand runhugo server -D.