Skip to content

Commit 83d777d

Browse files
authored
Update plugin-options.md
For #294
1 parent 8180c04 commit 83d777d

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

website/docs/getting-started/plugin-options.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ Either a file path to an OpenAPI YAML/JSON file, or a url to one hosted on some
1414

1515
Route URL at which docs would be available, this will use the theme component `@theme/ApiDoc` from `docusaurus-theme-redoc` to render the page. You can also skip this option and render the docs as you wish using a custom page.
1616

17+
### url (optional, string: download url)
18+
19+
A url pointing to an OpenAPI spec. This will be used as download url and spec will be used for rendering. This might be needed because by default the download url will point to a processed and parsed file generated by redocusaurus.
20+
1721
### layout (optional, object: layoutProps)
1822

1923
An object to pass as layout props. Useful to set title/description of the page. See all properties available [here](https://github.com/rohit-gohri/redocusaurus/blob/main/packages/docusaurus-plugin-redoc/src/options.ts#L3).

0 commit comments

Comments
 (0)