Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update build commands in README.md and start in package.json #678

Merged
merged 2 commits into from
Feb 5, 2024
Merged

Update build commands in README.md and start in package.json #678

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f74fa9
Update build commands in README.md and package.json
raikbitters Feb 5, 2024
bf173da
Add OpenAPI documentation generation plugin
raikbitters Feb 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
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
View file
Open in desktop
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
Loading