Skip to content

Commit ef3b168

Browse files
authored
Merge pull request #56 from splitwise/npm
Use NPM for managing redoc-cli and build/serve scripts
2 parents 29be4ae + 6f4cf59 commit ef3b168

4 files changed

Lines changed: 6063 additions & 3 deletions

File tree

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,6 @@ build/
2222
_yardoc
2323
doc/
2424
.idea/
25+
26+
# NodeJS
27+
node_modules/

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,15 @@ These API docs follow the [OpenAPI v3](https://swagger.io/specification/) specif
1414

1515
### Developing
1616
```
17-
$ npm install -g redoc-cli
18-
$ redoc-cli serve splitwise.yaml --watch
17+
$ npm install
18+
$ npm run serve
1919
```
2020

21+
This will start a local HTTP server that serves the documentation and rebuilds whenever any of the OpenAPI source files are modified.
22+
2123
### Compiling
2224
This will create a zero-dependency HTML file at docs/index.html.
2325

2426
```
25-
$ redoc-cli bundle splitwise.yaml -o docs/index.html
27+
$ npm run build
2628
```

0 commit comments

Comments
 (0)