Add global-agent to dependencies; Update Readme w/ instructions
Signed-off-by: zjpersc <zjpersc@gmail.com>
This commit is contained in:
@@ -40,6 +40,13 @@ yarn start
|
||||
yarn techdocs-cli:dev [...options]
|
||||
```
|
||||
|
||||
### Connecting behind a proxy
|
||||
```sh
|
||||
# Prior to executing the techdocs-cli command
|
||||
export GLOBAL_AGENT_HTTPS_PROXY=${HTTP_PROXY}
|
||||
export GLOBAL_AGENT_NO_PROXY=${NO_PROXY}
|
||||
```
|
||||
|
||||
### Using an example docs project
|
||||
|
||||
For the purpose of local development, we have created an example documentation project. You are of course also free to create your own local test site - all it takes is a `docs/index.md` and an `mkdocs.yml` in a directory.
|
||||
|
||||
@@ -69,6 +69,7 @@
|
||||
"commander": "^9.1.0",
|
||||
"dockerode": "^3.3.1",
|
||||
"fs-extra": "^10.0.1",
|
||||
"global-agent": "^3.0.0",
|
||||
"http-proxy": "^1.18.1",
|
||||
"react-dev-utils": "^12.0.0-next.60",
|
||||
"serve-handler": "^6.1.3",
|
||||
|
||||
Reference in New Issue
Block a user