Skip to content

Commit 042a1db

Browse files
chalinchalin
authored
Upgrade Docsy to v0.13.1-0.20260205160058 (#412)
1 parent cac6358 commit 042a1db

16 files changed

Lines changed: 267 additions & 100 deletions

‎.cspell.yml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
version: "0.2"
1+
version: '0.2'
22
caseSensitive: true
33
words:
44
- docset
55
- Docsy
6+
- gohugoio
67
- Goldydocs
78
- pageinfo

‎CONTRIBUTING.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,21 @@ information on using pull requests.
2626

2727
This project follows
2828
[Google's Open Source Community Guidelines](https://opensource.google.com/conduct/).
29+
30+
## Maintainer notes
31+
32+
### Upgrade Docsy
33+
34+
Update Docsy to the latest tagged release:
35+
36+
```bash
37+
npm run update:hugo-modules
38+
```
39+
40+
Or update to the latest commit on the main branch:
41+
42+
```bash
43+
npm run update:docsy:main
44+
```
45+
46+
<!-- cSpell:ignore hugo docsy -->

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,3 +215,5 @@ of the user guide for instructions on how to install `go`.
215215
https://gohugo.io/hugo-modules/use-modules/#use-a-module-for-a-theme
216216
[Netlify]: https://netlify.com
217217
[Docker Compose documentation]: https://docs.docker.com/compose/gettingstarted/
218+
219+
<!-- cSpell:ignore hugo docsy TOCSS -->

‎assets/scss/_styles_project.scss‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,17 @@ https://www.docsy.dev/docs/content/lookandfeel/#project-style-files
77
@import 'td/color-adjustments-dark';
88
@import 'td/code-dark';
99
@import 'td/gcs-search-dark';
10+
@import 'td/extra/buttons';
11+
@import 'td/extra/main-container';
12+
13+
// Example of color tuning
14+
15+
.td-box--primary {
16+
// TODO: rework the td-box--* classes so that they don't override `color`;
17+
// otherwise we can't use Bootstrap's CSS variables:
18+
// --bs-link-color: $color !important;
19+
// --bs-link-color-rgb: red !important;
20+
a {
21+
color: tint-color($primary, 80%) !important;
22+
}
23+
}

‎content/en/_index.md‎

Lines changed: 40 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,34 @@
11
---
22
title: Goldydocs
3+
description: Porridge temperature assessment &mdash; in the cloud!
34
---
45

5-
<style>
6-
.td-heading-self-link {
7-
display: none;
8-
}
9-
</style>
10-
11-
{{< blocks/cover title="Welcome to Goldydocs: A Docsy Example Project!" image_anchor="top" height="full" >}}
12-
13-
<a class="btn btn-lg btn-primary me-3 mb-4" href="/docs/">
14-
Learn More <i class="fas fa-arrow-alt-circle-right ms-2"></i>
15-
</a>
16-
<a class="btn btn-lg btn-secondary me-3 mb-4" href="https://github.com/google/docsy-example">
17-
Download <i class="fab fa-github ms-2 "></i>
18-
</a>
19-
<p class="lead mt-5">Porridge temperature assessment &mdash; in the cloud!</p>
20-
21-
{{< blocks/link-down color="info" >}} {{< /blocks/cover >}}
6+
{{% blocks/cover
7+
title="Welcome to Goldydocs: A Docsy Example Project!"
8+
image_anchor="top"
9+
height="full td-below-navbar"
10+
%}}
11+
12+
<!-- prettier-ignore -->
13+
{{% _param description %}}
14+
{.display-6}
15+
16+
<!-- prettier-ignore -->
17+
<div class="td-cta-buttons my-5">
18+
<button {{% _param btn-lg primary %}} href="docs/">
19+
Learn More
20+
{{% _param FA solid arrow-alt-circle-right "" %}}
21+
</button>
22+
<button {{% _param btn-lg secondary %}}
23+
href="{{ param github_url }}">
24+
Download
25+
{{% _param FA brands github "" %}}
26+
</button>
27+
</div>
28+
29+
{{% blocks/link-down color="info" %}}
30+
31+
{{% /blocks/cover %}}
2232

2333
{{% blocks/lead color="primary" %}}
2434

@@ -33,37 +43,43 @@ to create your own real websites with [Docsy](https://docsy.dev))
3343

3444
{{% blocks/section color="white" type="row" %}}
3545

36-
{{% blocks/feature icon="fa-lightbulb" title="New chair metrics!" %}}
46+
{{% blocks/feature title="New chair metrics!" icon="fa-lightbulb" %}}
3747

3848
The Goldydocs UI now shows chair size metrics by default.
3949

4050
Please follow this space for updates!
4151

4252
{{% /blocks/feature %}}
4353

44-
{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/google/docsy-example" %}}
54+
{{% blocks/feature
55+
title="Contributions welcome!" icon="fab fa-github"
56+
url="https://github.com/google/docsy-example"
57+
%}}
4558

4659
We do a [Pull Request](https://github.com/google/docsy-example/pulls)
4760
contributions workflow on **GitHub**. New users are always welcome!
4861

4962
{{% /blocks/feature %}}
5063

51-
{{% blocks/feature icon="fab fa-x-twitter" title="Follow us on X!" url="https://x.com/docsydocs" %}}
64+
{{% blocks/feature
65+
title="Follow us on X!" icon="fab fa-x-twitter"
66+
url="https://x.com/docsydocs"
67+
%}}
5268

5369
For announcement of latest features etc.
5470

5571
{{% /blocks/feature %}}
5672

5773
{{% /blocks/section %}}
5874

59-
{{% blocks/section type="row text-center" %}}
75+
{{% blocks/section type="row text-center h1" %}}
6076

61-
# This is the second section
77+
This is the second section
6278

6379
{{% /blocks/section %}}
6480

65-
{{% blocks/section type="row text-center" %}}
81+
{{% blocks/section type="row text-center h1" %}}
6682

67-
# This is the another section with center alignment
83+
This is the another section with center alignment
6884

6985
{{% /blocks/section %}}

‎content/en/about/index.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ linkTitle: About
44
menu: { main: { weight: 10 } }
55
---
66

7-
{{% blocks/cover title="About Goldydocs" image_anchor="bottom" height="auto" %}}
7+
{{% blocks/cover title="About Goldydocs" image_anchor="bottom" height="auto td-below-navbar" %}}
88

99
A sample site using the Docsy Hugo theme.
1010

@@ -19,14 +19,14 @@ different sections of the documentation and site for more ideas.
1919

2020
{{% /blocks/lead %}}
2121

22-
{{% blocks/section type="row text-center" %}}
22+
{{% blocks/section type="row text-center h1" %}}
2323

24-
# This is another section with center alignment
24+
This is another section with center alignment
2525

2626
{{% /blocks/section %}}
2727

28-
{{% blocks/section %}}
28+
{{% blocks/section type="h1" %}}
2929

30-
# This is another section with default alignment
30+
This is another section with default alignment
3131

3232
{{% /blocks/section %}}

‎content/en/site.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Website information
3+
likeTitle: Site info
4+
type: docs
5+
params:
6+
body_class: td-no-left-sidebar
7+
hide_feedback: true
8+
cSpell:ignore: docsy
9+
---
10+
11+
{{% td/site-build-info/netlify team="docsy-example" %}}

‎content/fa/_index.md‎

Lines changed: 50 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,38 @@
11
---
2+
# cSpell:disable
23
title: اسناد گلدی
4+
description: ارزیابی درجه حرارت فرنی &mdash; در فضای ابری!
35
---
46

5-
{{< blocks/cover title="به اسناد گلدی خوش آمدید. این یک نمونه برای پوسته داکسی می‌باشد." image_anchor="top" height="full" >}}
6-
<a class="btn btn-lg btn-primary me-3 mb-4" href="docs/">
7-
بیشتر بخوانید <i class="fas fa-arrow-alt-circle-left ms-2"></i>
8-
</a>
9-
<a class="btn btn-lg btn-secondary me-3 mb-4" href="https://github.com/google/docsy-example">
10-
دانلود <i class="fab fa-github ms-2 "></i>
11-
</a>
12-
<p class="lead mt-5">ارزیابی درجه حرارت فرنی - در فضای ابری!</p>
13-
{{< blocks/link-down color="info" >}}
14-
{{< /blocks/cover >}}
15-
7+
{{% blocks/cover
8+
title="به اسناد گلدی خوش آمدید. این یک نمونه برای پوسته داکسی می‌باشد."
9+
image_anchor="top"
10+
height="full td-below-navbar"
11+
%}}
12+
13+
<!-- prettier-ignore -->
14+
{{% _param description %}}
15+
{.display-6}
16+
17+
<!-- prettier-ignore -->
18+
<div class="td-cta-buttons my-5">
19+
<button {{% _param btn-lg primary %}} href="docs/">
20+
بیشتر بخوانید
21+
{{% _param FA solid arrow-alt-circle-left "" %}}
22+
</button>
23+
<button {{% _param btn-lg secondary %}}
24+
href="{{ param github_url }}">
25+
دانلود
26+
{{% _param FA brands github "" %}}
27+
</button>
28+
</div>
29+
30+
{{% blocks/link-down color="info" %}}
31+
32+
{{% /blocks/cover %}}
1633

1734
{{% blocks/lead color="primary" %}}
35+
1836
اسناد گلدی یک وبسایت آماده کرده است درباره ارزیابی در حرارت فرنی، سایز صندلی و مشخصه های نرمی!
1937
شما حتی خواهید فهمید چه کسی فرنی **شما** را خورده است!
2038

@@ -23,53 +41,45 @@ title: اسناد گلدی
2341

2442
{{% /blocks/lead %}}
2543

26-
{{< blocks/section color="dark" type="row" >}}
27-
{{% blocks/feature icon="fa-lightbulb" title="معیارهای جدید صندلی!" %}}
44+
{{% blocks/section color="white" type="row" %}}
45+
46+
{{% blocks/feature title="معیارهای جدید صندلی!" icon="fa-lightbulb" %}}
47+
2848
اسناد گلدی به شما معیارهای اندازه صندلی را به شما نشان می‌دهد.
2949

3050
برای اطلاع از به روز رسانی ها دنبال کنید.
51+
3152
{{% /blocks/feature %}}
3253

54+
{{% blocks/feature
55+
title="همکاری" icon="fab fa-github"
56+
url="https://github.com/google/docsy-example"
57+
%}}
3358

34-
{{% blocks/feature icon="fab fa-github" title="همکاری" url="https://github.com/google/docsy-example" %}}
3559
ما یک فرآیند [پول ریکوئست](https://github.com/google/docsy-example/pulls) در **گیتهاب** داریم. ما همیشه از همکاران جدید
3660
خوشحال می‌شویم.
37-
{{% /blocks/feature %}}
38-
3961

40-
{{% blocks/feature icon="fab fa-x-twitter" title="ما را در X دنبال کنید." url="https://x.com/docsydocs" %}}
41-
برای اطلاع از آخرین خبرها
4262
{{% /blocks/feature %}}
4363

64+
{{% blocks/feature
65+
title="ما را در X دنبال کنید." icon="fab fa-x-twitter"
66+
url="https://x.com/docsydocs"
67+
%}}
4468

45-
{{< /blocks/section >}}
46-
47-
48-
{{< blocks/section >}}
49-
<h1 class="text-center">این قسمت دوم است.</h1>
50-
{{< /blocks/section >}}
51-
52-
69+
برای اطلاع از آخرین خبرها
5370

54-
{{< blocks/section type="row" >}}
55-
{{% blocks/feature icon="fab fa-app-store-ios" title="از **فروشگاه اپ استور** دانلود کنید" %}}
56-
Get the Goldydocs app!
5771
{{% /blocks/feature %}}
5872

73+
{{% /blocks/section %}}
5974

60-
{{% blocks/feature icon="fab fa-github" title="همکاری" url="https://github.com/google/docsy-example" %}}
61-
ما یک فرآیند [پول ریکوئست](https://github.com/google/docsy-example/pulls) در **گیتهاب** داریم. ما همیشه از همکاران جدید
62-
خوشحال می‌شویم.
63-
{{% /blocks/feature %}}
75+
{{% blocks/section type="row text-center h1" %}}
6476

77+
این قسمت دوم است.
6578

66-
{{% blocks/feature icon="fab fa-x-twitter" title="ما را در X دنبال کنید." url="https://x.com/GoHugoIO" %}}
67-
برای اطلاع از آخرین خبرها
68-
{{% /blocks/feature %}}
79+
{{% /blocks/section %}}
6980

81+
{{% blocks/section type="row text-center h1" %}}
7082

71-
{{< /blocks/section >}}
83+
این یک قسمت دیگر است با تراز وسط
7284

73-
{{< blocks/section >}}
74-
<h1 class="text-center">این یک قسمت دیگر است.</h1>
75-
{{< /blocks/section >}}
85+
{{% /blocks/section %}}

‎content/fa/about/featured-background.jpg‎

-485 KB
Binary file not shown.

content/fa/about/index.html renamed to content/fa/about/index.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,34 @@
11
---
2+
# cSpell:disable
23
title: درباره اسناد گلدی
34
linkTitle: درباره‌ی ما
45
menu: {main: {weight: 10}}
56
---
67

7-
{{< blocks/cover title="درباره اسناد گلدی" image_anchor="bottom" height="min" >}}
8-
<p class="lead mt-5">یک نمونه برای پوسته‌ی داکسی، قدرت گرفته از هوگو</p>
9-
{{< /blocks/cover >}}
8+
{{% blocks/cover title="درباره اسناد گلدی" image_anchor="bottom" height="min td-below-navbar" %}}
9+
10+
یک نمونه برای پوسته‌ی داکسی، قدرت گرفته از هوگو
11+
12+
{{% /blocks/cover %}}
1013

1114
{{% blocks/lead %}}
12-
اسناد گلدی یک نمونه سایت با استفاده از <a href="https://github.com/google/docsy">پوسته‌ی داکسی</a> و قدرت گرفته از هوگو
15+
16+
اسناد گلدی یک نمونه سایت با استفاده از [پوسته‌ی داکسی](https://github.com/google/docsy) و قدرت گرفته از هوگو
1317
است که به شما نشان می‌دهد چه ویژگی هایی دارد و یک ساختار کامل برای شما ایجاد کرده است.
1418
این سایت برای شما ایجاد شده است که دریافت کنید و هرچقد که می‌خواهید آن را تغییر دهید. برای گرفتن ایده های بیشتر
1519
می‌توانید از قسمت های مختلف سایت دیدن کنید.
20+
1621
{{% /blocks/lead %}}
1722

1823

19-
{{< blocks/section >}}
20-
<h1 class="text-center">این یک قسمت دیگر است.</h1>
21-
{{< /blocks/section >}}
24+
{{% blocks/section type="row text-center" %}}
25+
26+
# این یک قسمت دیگر است با تراز وسط
27+
28+
{{% /blocks/section %}}
29+
30+
{{% blocks/section %}}
2231

32+
# این یک قسمت دیگر است با تراز پیش‌فرض
2333

24-
{{< blocks/section >}}
25-
<h1 class="text-center">این یک قسمت دیگر است.</h1>
26-
{{< /blocks/section >}}
34+
{{% /blocks/section %}}

0 commit comments

Comments
 (0)