Improved types and updated documentation (#71)

* v1.0.0-alpha44
This commit is contained in:
Daniel Lautzenheiser
2022-11-07 10:27:58 -05:00
committed by GitHub
parent ba1cde4e01
commit c55d1f912f
91 changed files with 3695 additions and 2546 deletions

View File

@ -14,6 +14,7 @@ The local backend allows you to use Static CMS with a local git repository, inst
### Example
<CodeTabs>
```yaml
backend:
name: git-gateway
@ -22,6 +23,16 @@ backend:
local_backend: true
```
```js
backend: {
name: 'git-gateway',
},
// when using the default proxy server port
local_backend: true,
```
</CodeTabs>
## Usage
1. Run `npx @staticcms/proxy-server` from the root directory of the above repository.
@ -44,8 +55,9 @@ local_backend: true
PORT=8082
```
2. Update the `local_backend` object in `config.yml` and specify a `url` property to use your custom port number
2. Update the `local_backend` object in `config` and specify a `url` property to use your custom port number
<CodeTabs>
```yaml
backend:
name: git-gateway
@ -56,3 +68,17 @@ local_backend:
# when accessing the local site from a host other than 'localhost' or '127.0.0.1'
allowed_hosts: ['192.168.0.1']
```
```js
backend: {
name: 'git-gateway',
},
local_backend: {
// when using a custom proxy server port
url: 'http://localhost:8082/api/v1',
// when accessing the local site from a host other than 'localhost' or '127.0.0.1'
allowed_hosts: ['192.168.0.1'],
},
```
</CodeTabs>