Skip to content

Commit

Permalink
feat: include new rapidoc attributes
Browse files Browse the repository at this point in the history
  • Loading branch information
ahmadnassri committed Jul 23, 2024
1 parent 9e9e939 commit 0dc31e6
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 11 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,9 @@ services:
theme: dark
```
[RapiDoc]: https://github.com/mrin9/RapiDoc
[RapiDoc]: https://rapidocweb.com/
[`serve-reload-replace`]: https://github.com/ahmadnassri/node-serve-reload-replace
[RapiDoc Attributes]: https://mrin9.github.io/RapiDoc/api.html
[RapiDoc Attributes]: https://rapidocweb.com/api.html

----
> Author: [Ahmad Nassri](https://www.ahmadnassri.com/) •
Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Features

a [RapiDoc](https://github.com/mrin9/RapiDoc) server that watches for changes in your spec file and automatically reloads connected browser sessions with ever spec file change.
a [RapiDoc](https://rapidocweb.com/) server that watches for changes in your spec file and automatically reloads connected browser sessions with ever spec file change.

> _**Note**: uses [`serve-reload-replace`](https://github.com/ahmadnassri/node-serve-reload-replace) under the hood to run the HTTP server, and monitor changes_
Expand All @@ -26,7 +26,7 @@ $ docker run -it -p 8080:8080 -e "spec-url=https://petstore.swagger.io/v2/swagge

### RapiDoc Attributes

All the [RapiDoc Attributes](https://mrin9.github.io/RapiDoc/api.html) are supported through environment variables:
All the [RapiDoc Attributes](https://rapidocweb.com/api.html) are supported through environment variables:

```bash
$ docker run -it --rm -p 8080:8080 \
Expand Down
28 changes: 21 additions & 7 deletions src/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,37 +10,41 @@
<body>
<rapi-doc
spec-url="<!--#echo var="spec-url" -->"
update-route="<!--#echo var="update-route" -->"
sort-schemas="<!--#echo var="sort-schemas" -->"
sort-tags="<!--#echo var="sort-tags" -->"
sort-endpoints-by="<!--#echo var="sort-endpoints-by" -->"
heading-text="<!--#echo var="heading-text" -->"
goto-path="<!--#echo var="goto-path" -->"
fill-request-fields-with-example="<!--#echo var="fill-request-fields-with-example" -->"
persist-auth="<!--#echo var="persist-auth" -->"

theme="<!--#echo var="theme" -->"
bg-color="<!--#echo var="bg-color" -->"
text-color="<!--#echo var="text-color" -->"
header-color="<!--#echo var="header-color" -->"
primary-color="<!--#echo var="primary-color" -->"
load-fonts="<!--#echo var="load-fonts" -->"
regular-font="<!--#echo var="regular-font" -->"
mono-font="<!--#echo var="mono-font" -->"
font-size="<!--#echo var="font-size" -->"
css-file="<!--#echo var="css-file" -->"
css-classes="<!--#echo var="css-classes" -->"

show-method-in-nav-bar="<!--#echo var="show-method-in-nav-bar" -->"
use-path-in-nav-bar="<!--#echo var="use-path-in-nav-bar" -->"
nav-bg-color="<!--#echo var="nav-bg-color" -->"
nav-bg-image="<!--#echo var="nav-bg-image" -->"
nav-bg-image-size="<!--#echo var="nav-bg-image-size" -->"
nav-bg-image-repeat="<!--#echo var="nav-bg-image-repeat" -->"
nav-text-color="<!--#echo var="nav-text-color" -->"
nav-hover-bg-color="<!--#echo var="nav-hover-bg-color" -->"
nav-hover-text-color="<!--#echo var="nav-hover-text-color" -->"
nav-accent-color="<!--#echo var="nav-accent-color" -->"
nav-accent-text-color="<!--#echo var="nav-accent-text-color" -->"
nav-active-item-marker="<!--#echo var="nav-active-item-marker" -->"
nav-item-spacing="<!--#echo var="nav-item-spacing" -->"
on-nav-tag-click="<!--#echo var="on-nav-tag-click" -->"

layout="<!--#echo var="layout" -->"
render-style="<!--#echo var="render-style" -->"
schema-style="<!--#echo var="schema-style" -->"
schema-expand-level="<!--#echo var="schema-expand-level" -->"
schema-description-expanded="<!--#echo var="schema-description-expanded" -->"
default-schema-tab="<!--#echo var="default-schema-tab" -->"
response-area-height="<!--#echo var="response-area-height" -->"

show-info="<!--#echo var="show-info" -->"
Expand All @@ -53,13 +57,23 @@
allow-search="<!--#echo var="allow-search" -->"
allow-advance-search="<!--#echo var="allow-advance-search" -->"
allow-try="<!--#echo var="allow-try" -->"
show-curl-before-try="<!--#echo var="show-curl-before-try" -->"
allow-server-selection="<!--#echo var="allow-server-selection" -->"
allow-schema-description-expand-toggle="<!--#echo var="allow-schema-description-expand-toggle" -->"

schema-style="<!--#echo var="schema-style" -->"
schema-expand-level="<!--#echo var="schema-expand-level" -->"
schema-description-expanded="<!--#echo var="schema-description-expanded" -->"
schema-hide-read-only="<!--#echo var="schema-hide-read-only" -->"
schema-hide-write-only="<!--#echo var="schema-hide-write-only" -->"
default-schema-tab="<!--#echo var="default-schema-tab" -->"

server-url="<!--#echo var="server-url" -->"
default-api-server="<!--#echo var="default-api-server" -->"
api-key-name="<!--#echo var="api-key-name" -->"
api-key-location="<!--#echo var="api-key-location" -->"
api-key-value="<!--#echo var="api-key-value" -->"
fetch-credentials="<!--#echo var="fetch-credentials" -->"
>
</rapi-doc>
</body>
Expand Down

0 comments on commit 0dc31e6

Please sign in to comment.