Skip to content

Commit

Permalink
Update build commands in README.md and start in package.json (#678)
Browse files Browse the repository at this point in the history
* Update build commands in README.md and package.json

* Add OpenAPI documentation generation plugin
  • Loading branch information
raikbitters authored Feb 5, 2024
1 parent 0fafa3d commit 9f0d97b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ The documentation built with [Docusaurus](https://docusaurus.io).

The search is implemented using [DocSearch](https://docsearch.algolia.com).

The OpenAPI documentation is generated using
[PaloAltoNetworks docusaurus-openapi-docs plugin](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs).

## Running locally

1. Install the dependencies
Expand All @@ -16,8 +19,9 @@ npm install
npm run start
```

3. For production ready build use the next command:
3. For production ready build use the next commands:
```bash
npm run gen-all
npm run build
```

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "ReportPortal Documentation",
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
"start": "npm run re-gen && docusaurus start",
"build": "docusaurus build",
"lint": "eslint src/**/*.{js,jsx}",
"format": "npm run lint -- --fix",
Expand Down

0 comments on commit 9f0d97b

Please sign in to comment.