Skip to content

Commit 1b70ea9

Browse files
committed
docs: build and serve documentation locally
1 parent e8c0bb3 commit 1b70ea9

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,18 @@
66

77
https://opensource.adobe.com/spacecat-api-service/
88

9+
### Build documentation locally
10+
11+
```bash
12+
$ npm docs
13+
```
14+
15+
### Serve the documentation locally
16+
17+
```bash
18+
$ npm docs:serve
19+
```
20+
921
## Installation
1022

1123
```bash
@@ -26,7 +38,8 @@ To set up local development for `spacecat-api-service`, follow these steps:
2638
AWS_REGION=your_aws_region
2739
AWS_ACCESS_KEY_ID=your_access_key_id
2840
AWS_SECRET_ACCESS_KEY=your_secret_access_key
29-
```
41+
```
42+
3043
2. Start the development server
3144

3245
```

0 commit comments

Comments
 (0)