Skip to content

Commit 387e8e6

Browse files
committed
feat(examples): add collapsible <details> shortcode and style for better UX on multi-file pages
- Introduced a reusable Hugo shortcode: layouts/shortcodes/details.html - Wrapped long example-file blocks in collapsible <details> sections on: - community-provisioners/service - community-provisioners/dns - Applied consistent styling in assets/scss/examples.scss: - Light/dark mode support - Soft borders, spacing, and hover effects - Improved code block readability inside collapses Closes #201
1 parent 0c98caa commit 387e8e6

File tree

4 files changed

+65
-5
lines changed

4 files changed

+65
-5
lines changed

assets/scss/_examples.scss

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,35 @@
1313
}
1414
}
1515

16+
/* Collapsible <details> styling */
17+
details {
18+
margin: 1.2rem 0;
19+
padding: 0.6rem 1rem;
20+
border: 1px solid #ccc;
21+
border-radius: 6px;
22+
background-color: #f9f9f9;
23+
}
24+
25+
details[open] {
26+
background-color: #fefefe;
27+
border-color: #999;
28+
}
29+
30+
details summary {
31+
font-weight: 600;
32+
cursor: pointer;
33+
margin: -0.4rem -1rem 0.6rem -1rem;
34+
padding: 0.6rem 1rem;
35+
background-color: #ececec;
36+
border-radius: 6px 6px 0 0;
37+
transition: background-color 0.2s ease;
38+
}
39+
40+
details summary:hover {
41+
background-color: #e2e2e2;
42+
}
43+
44+
1645
@media (min-width: 768px) {
1746
.td-404 main,
1847
.td-main main .examples-index-page {

content/en/examples/score/resources/community-provisioners/dns.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,21 @@ flavor: "Resources"
1010

1111
---
1212

13+
{{% details "score.yaml" %}}
1314
{{% example-file filename="score.yaml" dir="score/resources/community-provisioners/dns" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
15+
{{% /details %}}
1416

1517
{{< tabs >}}
1618
{{% tab name="score-compose" %}}
19+
20+
{{% details "10-dns-in-codespace.provisioners.yaml" %}}
1721
{{% example-file filename="10-dns-in-codespace.provisioners.yaml" dir="score/resources/community-provisioners/dns/score-compose" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
22+
{{% /details %}}
23+
24+
{{% details "10-dns-with-url.provisioners.yaml" %}}
1825
{{% example-file filename="10-dns-with-url.provisioners.yaml" dir="score/resources/community-provisioners/dns/score-compose" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
1926
{{% example-file filename="README.md" dir="score/resources/community-provisioners/dns/score-compose" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
27+
{{% /details %}}
2028

2129
---
2230

@@ -66,9 +74,12 @@ docker ps
6674

6775
{{%/ tab %}}
6876
{{% tab name="score-k8s" %}}
77+
78+
{{% details "10-dns-in-codespace.provisioners.yaml" %}}
6979
{{% example-file filename="10-dns-in-codespace.provisioners.yaml" dir="score/resources/community-provisioners/dns/score-k8s" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
7080
{{% example-file filename="10-dns-with-url.provisioners.yaml" dir="score/resources/community-provisioners/dns/score-k8s" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
7181
{{% example-file filename="README.md" dir="score/resources/community-provisioners/dns/score-k8s" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
82+
{{% /details %}}
7283

7384
---
7485

content/en/examples/score/resources/community-provisioners/service.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,25 @@ excerpt: ''
77
hasMore: false
88
parent: "Community Provisioners"
99
flavor: "Resources"
10-
1110
---
1211

12+
{{% details "score-backend.yaml" %}}
1313
{{% example-file filename="score-backend.yaml" dir="score/resources/community-provisioners/service" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
14+
{{% /details %}}
15+
16+
{{% details "score-frontend.yaml" %}}
1417
{{% example-file filename="score-frontend.yaml" dir="score/resources/community-provisioners/service" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
18+
{{% /details %}}
1519

1620
{{< tabs >}}
21+
1722
{{% tab name="score-compose" %}}
23+
24+
{{% details "10-service.provisioners.yaml (score-compose)" %}}
1825
{{% example-file filename="10-service.provisioners.yaml" dir="score/resources/community-provisioners/service/score-compose" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
26+
{{% /details %}}
1927

20-
---
28+
...
2129

2230
Initialize your local workspace, by importing a specific community provisioner:
2331

@@ -63,12 +71,19 @@ See the running containers:
6371
docker ps
6472
```
6573

66-
{{%/ tab %}}
74+
{{% /tab %}}
75+
6776
{{% tab name="score-k8s" %}}
77+
78+
{{% details "10-service-with-netpol.provisioners.yaml (score-k8s)" %}}
6879
{{% example-file filename="10-service-with-netpol.provisioners.yaml" dir="score/resources/community-provisioners/service/score-k8s" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
80+
{{% /details %}}
81+
82+
{{% details "10-service.provisioners.yaml (score-k8s)" %}}
6983
{{% example-file filename="10-service.provisioners.yaml" dir="score/resources/community-provisioners/service/score-k8s" githubUrl="https://github.com/score-spec/community-provisioners/blob/main" %}}
84+
{{% /details %}}
7085

71-
---
86+
...
7287

7388
Initialize your local workspace, by importing a specific community provisioner:
7489

@@ -114,5 +129,6 @@ See the running containers:
114129
kubectl get all
115130
```
116131

117-
{{%/ tab %}}
132+
{{% /tab %}}
133+
118134
{{< /tabs >}}

layouts/shortcodes/details.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<details{{ with .Get 1 }} {{ . | safeHTML }}{{ end -}}>
2+
<summary>{{ with .Get 0 -}}{{ . | safeHTML }}{{ else -}}{{ errorf "No summary provided"}}{{ end -}}</summary>
3+
{{ with .Inner -}}{{ . | markdownify}}{{ else -}}{{ errorf "No details provided"}}{{ end -}}
4+
</details>

0 commit comments

Comments
 (0)