-
Notifications
You must be signed in to change notification settings - Fork 114
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into feature/i18n
- Loading branch information
Showing
12 changed files
with
136 additions
and
69 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
'docusaurus-plugin-redoc': minor | ||
'redocusaurus': minor | ||
--- | ||
|
||
Add support for auto-loading folder |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
import type { | ||
PluginOptions, | ||
PluginDirectUsageOptions, | ||
} from 'docusaurus-plugin-redoc'; | ||
import type { ThemeOptions } from 'docusaurus-theme-redoc'; | ||
|
||
interface FolderOptions { | ||
/** | ||
* Default is `openapi`. This is similar to how | ||
* Will load all YAML or JSON files in the folder | ||
* that are named `openapi` or end with `.openapi`, like: | ||
* - `index.openapi.yaml` | ||
* - `swagger.openapi.yaml` | ||
* - `swagger.openapi.json` | ||
*/ | ||
folder?: string; | ||
/** | ||
* The path at which the files will be rendered, | ||
* if the file is called `index.openapi.yaml` it will be rendered at base path itself | ||
* Otherwise the name of the file path from the base folder will be used as the url path | ||
*/ | ||
routeBasePath?: string; | ||
} | ||
|
||
export type SpecOptions = Omit<PluginOptions, keyof PluginDirectUsageOptions>; | ||
|
||
export type PresetOptions = { | ||
id?: string; | ||
debug?: boolean; | ||
/** | ||
* Path to the Redocly config file `redocly.yaml` | ||
* @see https://redocly.com/docs/cli/configuration/configuration-file/ | ||
*/ | ||
config?: string; | ||
specs?: SpecOptions[]; | ||
/** | ||
* The folder is not going to be hot-reloaded | ||
* but any changes to specs loaded at start will trigger live-reload | ||
*/ | ||
openapi?: FolderOptions; | ||
theme?: Omit<ThemeOptions, 'id'>; | ||
}; | ||
|
||
export type PresetEntry = ['redocusaurus', PresetOptions]; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters