Skip to content

Commit 9834b61

Browse files
committed
chore(README): fix formatting
1 parent 5a8ec93 commit 9834b61

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ bootstrap();
3737

3838
## Setup Options
3939

40-
Customize RapiDoc module behavior by providing an options object that adheres to the `RapidocCustomOptions` interface. Pass this object as the fourth argument to the `RapidocModule`#setup method.
40+
Customize RapiDoc module behavior by providing an options object that adheres to the `RapidocCustomOptions` interface. Pass this object as the fourth argument to the `RapidocModule#setup` method.
4141

4242
```typescript
4343
export interface RapidocCustomOptions {
@@ -64,7 +64,7 @@ There are slight changes compared to the `SwaggerCustomOptions` from the `@nestj
6464
- The introduction of `customLogo` enables changing the default RapiDoc logo in the sidebar. It should be a URL pointing to the custom logo.
6565
- The `validatorUrl` has been removed as it is not used by RapiDoc.
6666
- Both the `url` and `urls` attributes have been removed since they are not utilized by RapiDoc.
67-
- The `rapidocOptions` attribute has been added to configure the RapiDoc UI. This attribute must adhere to the `RapidocUIOptions` interface. Essentially, this interface represents a `camelCase` version (e.g., `sort-tags` -> `sortTags`) of the RapiDoc attributes. Correspondingly, the swaggerOptions option has been removed.
67+
- The `rapidocOptions` attribute has been added to configure the RapiDoc UI. This attribute must adhere to the `RapidocUIOptions` interface. Essentially, this interface represents a `camelCase` version (e.g., `sort-tags` -> `sortTags`) of the RapiDoc attributes. Correspondingly, the `swaggerOptions` option has been removed.
6868
> Note: `spec-url` attribute cannot be configured as the OpenAPI spec of the application is explicitly loaded into RapiDoc upon page load.
6969
7070

0 commit comments

Comments
 (0)