Skip to content

Commit 2ab47f2

Browse files
authored
Simpler expand widget (#786)
* Remove unused show-children code * Simplify expand shortcode Remove expand partial and use <details> element instead. Combine CSS rules for .openapi-prop and generic <details> styling * Directly use <details> for program options too * Rename expand shortcode to details, and title parameter to summary * arangoproxy: Disable 4 second wait time in OpenAPI validation function
1 parent 863ee99 commit 2ab47f2

File tree

20 files changed

+57
-158
lines changed

20 files changed

+57
-158
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -353,13 +353,13 @@ paragraphs will not be part of the blockquote.
353353
Admonitions inside of other shortcodes need to use the special syntax, too:
354354

355355
```markdown
356-
{{< expand title="Outer shortcode" >}}
356+
{{< details summary="Outer shortcode" >}}
357357
358358
{{</* tip */>}}
359359
Inner shortcode
360360
{{</* /tip */>}}
361361
362-
{{< /expand >}}
362+
{{< /details >}}
363363
```
364364

365365
#### Tags
@@ -472,9 +472,9 @@ Content or reminder that should not be rendered.
472472
The following shortcodes also exist but are rarely used:
473473

474474
- ```markdown
475-
{{< expand title="A short description" >}}
475+
{{< details summary="A short description" >}}
476476
Content that is collapsed by default but can be expanded.
477-
{{< /expand >}}
477+
{{< /details >}}
478478
```
479479

480480
- `{{< youtube id="dQw4w9WgXcQ" >}}` can be used to embed a single YouTube video,

site/content/3.10/arangograph/security-and-access-control/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ export OASIS_TOKEN='<TOKEN>'
122122
./oasisctl list roles --organization-id <ID> --format json | jq -r '.[] | select(.predefined == true) | "**\(.description)** (`\(.id)`):\n\(.permissions | split(", ") | map("- `\(.)`\n") | join(""))"'
123123
{{% /comment %}}
124124

125-
{{< expand title="List of predefined roles and their permissions" >}}
125+
{{< details summary="List of predefined roles and their permissions" >}}
126126

127127
{{</* tip */>}}
128128
The roles below are described following this pattern:
@@ -475,7 +475,7 @@ The roles below are described following this pattern:
475475
- `iam.user.get-personal-data`
476476
- `iam.user.update`
477477

478-
{{< /expand >}}
478+
{{< /details >}}
479479

480480
### How to create a custom role
481481

site/content/3.10/develop/http-api/administration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -966,7 +966,7 @@ Example not generated because it would require a valid license to demonstrate th
966966
curl --header 'accept: application/json' --dump - --data '"eyJncmFudCI6...(Base64-encoded license string)..."' -X PUT http://localhost:8529/_admin/license
967967
```
968968

969-
{{< expand title="Show output" >}}
969+
{{< details summary="Show output" >}}
970970
```bash
971971
HTTP/1.1 201 Created
972972
content-type: application/json
@@ -988,7 +988,7 @@ x-content-type-options: nosniff
988988
}
989989
}
990990
```
991-
{{< /expand >}}
991+
{{< /details >}}
992992

993993
## Shutdown
994994

site/content/3.11/arangograph/security-and-access-control/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ export OASIS_TOKEN='<TOKEN>'
122122
./oasisctl list roles --organization-id <ID> --format json | jq -r '.[] | select(.predefined == true) | "**\(.description)** (`\(.id)`):\n\(.permissions | split(", ") | map("- `\(.)`\n") | join(""))"'
123123
{{% /comment %}}
124124

125-
{{< expand title="List of predefined roles and their permissions" >}}
125+
{{< details summary="List of predefined roles and their permissions" >}}
126126

127127
{{</* tip */>}}
128128
The roles below are described following this pattern:
@@ -475,7 +475,7 @@ The roles below are described following this pattern:
475475
- `iam.user.get-personal-data`
476476
- `iam.user.update`
477477

478-
{{< /expand >}}
478+
{{< /details >}}
479479

480480
### How to create a custom role
481481

site/content/3.11/develop/http-api/administration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1075,7 +1075,7 @@ Example not generated because it would require a valid license to demonstrate th
10751075
curl --header 'accept: application/json' --dump - --data '"eyJncmFudCI6...(Base64-encoded license string)..."' -X PUT http://localhost:8529/_admin/license
10761076
```
10771077

1078-
{{< expand title="Show output" >}}
1078+
{{< details summary="Show output" >}}
10791079
```bash
10801080
HTTP/1.1 201 Created
10811081
content-type: application/json
@@ -1097,7 +1097,7 @@ x-content-type-options: nosniff
10971097
}
10981098
}
10991099
```
1100-
{{< /expand >}}
1100+
{{< /details >}}
11011101

11021102
## Shutdown
11031103

site/content/3.12/arangograph/security-and-access-control/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ export OASIS_TOKEN='<TOKEN>'
122122
./oasisctl list roles --organization-id <ID> --format json | jq -r '.[] | select(.predefined == true) | "**\(.description)** (`\(.id)`):\n\(.permissions | split(", ") | map("- `\(.)`\n") | join(""))"'
123123
{{% /comment %}}
124124

125-
{{< expand title="List of predefined roles and their permissions" >}}
125+
{{< details summary="List of predefined roles and their permissions" >}}
126126

127127
{{</* tip */>}}
128128
The roles below are described following this pattern:
@@ -475,7 +475,7 @@ The roles below are described following this pattern:
475475
- `iam.user.get-personal-data`
476476
- `iam.user.update`
477477

478-
{{< /expand >}}
478+
{{< /details >}}
479479

480480
### How to create a custom role
481481

site/content/3.12/develop/http-api/administration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1231,7 +1231,7 @@ Example not generated because it would require a valid license to demonstrate th
12311231
curl --header 'accept: application/json' --dump - --data '"eyJncmFudCI6...(Base64-encoded license string)..."' -X PUT http://localhost:8529/_admin/license
12321232
```
12331233

1234-
{{< expand title="Show output" >}}
1234+
{{< details summary="Show output" >}}
12351235
```bash
12361236
HTTP/1.1 201 Created
12371237
content-type: application/json
@@ -1253,7 +1253,7 @@ x-content-type-options: nosniff
12531253
}
12541254
}
12551255
```
1256-
{{< /expand >}}
1256+
{{< /details >}}
12571257

12581258
## Shutdown
12591259

site/content/3.12/develop/http-api/batch-requests.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ DELETE /_api/collection/products HTTP/1.1
359359
EOF
360360
```
361361

362-
{{< expand title="Show output" >}}
362+
{{< details summary="Show output" >}}
363363
```bash
364364
HTTP/1.1 200 OK
365365
content-type: multipart/form-data
@@ -512,7 +512,7 @@ Content-Length: 39
512512

513513
--SomeBoundaryValue--
514514
```
515-
{{< /expand >}}
515+
{{< /details >}}
516516

517517
Sending a batch request, setting the boundary implicitly. The server tries
518518
to find the boundary at the beginning of the request body in this case.
@@ -536,7 +536,7 @@ DELETE _api/collection/nonexistent2 HTTP/1.1
536536
EOF
537537
```
538538

539-
{{< expand title="Show output" >}}
539+
{{< details summary="Show output" >}}
540540
```bash
541541
HTTP/1.1 200 OK
542542
content-type: unset
@@ -586,4 +586,4 @@ Content-Length: 101
586586

587587
--SomeBoundaryValue--
588588
```
589-
{{< /expand >}}
589+
{{< /details >}}

site/content/3.12/develop/http-api/monitoring/logs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1038,7 +1038,7 @@ Example not generated because it changes on every run and returns up to 25MB of
10381038
curl --header 'accept: application/json' --dump - http://localhost:8529/_admin/server/api-calls
10391039
```
10401040

1041-
{{< expand title="Show output" >}}
1041+
{{< details summary="Show output" >}}
10421042
```bash
10431043
HTTP/1.1 200 OK
10441044
X-Arango-Queue-Time-Seconds: 0.000000
@@ -1074,4 +1074,4 @@ Content-Length: 257
10741074
}
10751075
}
10761076
```
1077-
{{< /expand >}}
1077+
{{< /details >}}

site/content/3.13/arangograph/security-and-access-control/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ export OASIS_TOKEN='<TOKEN>'
122122
./oasisctl list roles --organization-id <ID> --format json | jq -r '.[] | select(.predefined == true) | "**\(.description)** (`\(.id)`):\n\(.permissions | split(", ") | map("- `\(.)`\n") | join(""))"'
123123
{{% /comment %}}
124124

125-
{{< expand title="List of predefined roles and their permissions" >}}
125+
{{< details summary="List of predefined roles and their permissions" >}}
126126

127127
{{</* tip */>}}
128128
The roles below are described following this pattern:
@@ -475,7 +475,7 @@ The roles below are described following this pattern:
475475
- `iam.user.get-personal-data`
476476
- `iam.user.update`
477477

478-
{{< /expand >}}
478+
{{< /details >}}
479479

480480
### How to create a custom role
481481

0 commit comments

Comments
 (0)