Adding global-agent to dependencies; updated README w/ instructions

Signed-off-by: zjpersc <zjpersc@gmail.com>
This commit is contained in:
zjpersc
2023-02-26 20:44:08 -06:00
parent 1093f1b1cd
commit b348420a80
3 changed files with 13 additions and 0 deletions
+5
View File
@@ -0,0 +1,5 @@
---
'@techdocs/cli': patch
---
Adding global-agent to enable the ability to publish through a proxy
+7
View File
@@ -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.
+1
View File
@@ -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",