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

Fixed mentions of package name in readme #6

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fixed mentions of package name in readme #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Make sure you have a recent version of Node.js installed.
In your CLI run

```sh
$ npx @gitbook/openapi-autodoc -f ./path/to/my/openapi.yaml
$ npx @gitbook/openapi -f ./path/to/my/openapi.yaml
```

The CLI will generate documentation in your current working directory.
Expand All @@ -22,7 +22,7 @@ Space.

### In a continuous integration environment

You can set up @gitbook/openapi-autodoc in your continuous integration
You can set up @gitbook/openapi in your continuous integration
environment to automatically generate documentation from an OpenAPI
specification in your repository, or one generated earlier in the build process.

Expand All @@ -38,7 +38,7 @@ solution you use.
push a commit containing the generated documentation.
2. Install Node in your CI environment, if it's not already available.
3. If necessary, generate your openapi spec.
4. Run `npx @gitbook/openapi-autodoc -f ./path/to/my/openapi.yaml` in the root
4. Run `npx @gitbook/openapi -f ./path/to/my/openapi.yaml` in the root
directory of your repository.
5. If your generated documentation files have changed, commit them and push them
to the repository. Files to look for are `.gitbook.yaml` and the `docs` folder.
Expand Down