Grasscutters/mitmproxy
3
0
Fork 0
mirror of https://github.com/Grasscutters/mitmproxy.git synced 2024-11-22 07:08:10 +00:00
Code Issues Projects Releases Wiki Activity

docs: add more precise instructions on docs setup

Browse Source
This commit is contained in:
Jannik 2021-04-11 17:38:01 +02:00
parent b4d0e5b660
commit 20655fd4e2
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/README.md
View File

@ -4,10 +4,11 @@ This directory houses the mitmproxy documentation available at <https://docs.mit
## Quick Start ## Quick Start
1. Install [hugo](https://gohugo.io/). 1. Install [hugo "extended"](https://gohugo.io/getting-started/installing/).
- When using snap you can install it using `snap install hugo --channel=extended`
2. Windows users: Depending on your git settings, you may need to manually create a symlink from 2. Windows users: Depending on your git settings, you may need to manually create a symlink from
/docs/src/examples to /examples. /docs/src/examples to /examples.
3. Make sure the mitmproxy Python package is installed. See [CONTRIBUTING.md](../CONTRIBUTING.md#development-setup) for details. 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. 4. Run `./build.py` to generate additional documentation source files.
Now you can run `hugo server -D` in ./src. Now you can run `hugo server -D` in ./src.