Initialize npm package
This commit is contained in:
parent
ce6eefe8d8
commit
6f32fc1071
4 changed files with 2693 additions and 1 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -1 +1,2 @@
|
||||||
/redoc-static.html
|
/redoc-static.html
|
||||||
|
/node_modules
|
||||||
|
|
10
README.md
10
README.md
|
@ -5,6 +5,14 @@ Tekton API documentation in OpenAPI format.
|
||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
|
||||||
|
Build static HTML page:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
npx @redocly/cli build-docs openapi.yaml
|
npm run build
|
||||||
|
```
|
||||||
|
|
||||||
|
Lint:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
npm run lint
|
||||||
```
|
```
|
||||||
|
|
2660
package-lock.json
generated
Normal file
2660
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load diff
23
package.json
Normal file
23
package.json
Normal file
|
@ -0,0 +1,23 @@
|
||||||
|
{
|
||||||
|
"name": "tekton-api",
|
||||||
|
"description": "Tekton API documentation in OpenAPI format",
|
||||||
|
"scripts": {
|
||||||
|
"build": "redocly build-docs openapi.yaml",
|
||||||
|
"lint": "redocly lint openapi.yaml"
|
||||||
|
},
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "git+https://github.com/tekton-labs/tekton-api.git"
|
||||||
|
},
|
||||||
|
"keywords": [
|
||||||
|
"openapi"
|
||||||
|
],
|
||||||
|
"license": "MIT",
|
||||||
|
"bugs": {
|
||||||
|
"url": "https://github.com/tekton-labs/tekton-api/issues"
|
||||||
|
},
|
||||||
|
"homepage": "https://github.com/tekton-labs/tekton-api#readme",
|
||||||
|
"dependencies": {
|
||||||
|
"@redocly/cli": "^1.34.0"
|
||||||
|
}
|
||||||
|
}
|
Loading…
Add table
Add a link
Reference in a new issue